docs: add docstrings to nested test helpers (#64) - #76
Open
tschm wants to merge 1 commit into
Open
Conversation
Rhiza v1.2.2 widens the docs-coverage gate from ${SOURCE_FOLDER} to
"src tests .rhiza/tests", so helper classes and functions defined inside
test bodies are now scanned by interrogate --fail-under 100.
Documents the eight that were missing:
- _Event and its is_set/wait (test_interface.py)
- _InterruptingEvent and its is_set/wait (test_interface.py)
- _healthy x2 (test_lifecycle.py)
Tests-only change; no src/ or behaviour is touched.
Closes alihaskar#64
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR restores interrogate --fail-under 100 docstring coverage after the docs-coverage gate began scanning nested helpers inside tests/ by adding concise docstrings to helper classes/methods and nested helper functions within test bodies.
Changes:
- Added docstrings to nested helper event classes and their
is_set/waitmethods used by blocking-plot tests. - Added docstrings to nested
_healthy()retry helpers used by lifecycle integration tests.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
tests/pycharting/api/test_interface.py |
Adds docstrings to nested fake event helpers used to drive blocking/interrupt test behavior. |
tests/pycharting/core/test_lifecycle.py |
Adds docstrings to nested _healthy() polling helpers used by server health integration tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rhiza v1.2.2 widens the
docs-coveragegate from${SOURCE_FOLDER}tosrc tests .rhiza/tests, so helpers defined inside test bodies are now scanned byinterrogate --fail-under 100. Eight were undocumented, putting the gate at 97.4%.Adds a one-line docstring to each:
tests/pycharting/api/test_interface.py_Event,_Event.is_set,_Event.waittests/pycharting/api/test_interface.py_InterruptingEvent,.is_set,.waittests/pycharting/core/test_lifecycle.py_healthy(×2)__init__needs none — the gate runs with--ignore-init-method.Verification
Note: on
master(rhiza v0.18.8) the gate only scanssrc/, so it passes there already; this was verified against the v1.2.2 scope that surfaced it.Tests-only change — no
src/or behaviour touched.Closes #64