Docstring fixes #997
Merged
Docstring fixes #997
+44
−12
Conversation
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
… warnings - Add always_document_param_types = True for consistent parameter docs - Add typehints_use_rtype = False to embed return types inline - Suppress sphinx_autodoc_typehints.forward_reference warnings for types in TYPE_CHECKING blocks (used for circular import avoidance) This eliminates ~26 forward reference warnings from the docs build.
- builder.py: Remove duplicate "via" in loading phase documentation - freezer.py: Fix "workspacee" typo to "workspace"
- Fix malformed NumPy-style parameter documentation in template() - Fix double space in debug_log_template() parameter line - Standardize parameter descriptions to be concise
Add missing Returns and Raises sections to complete the NumPy-style docstring and fix RST field list parsing error.
Change [1] to [^id2] to properly reference the defined footnote for the tmux manpage source link.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #997 +/- ##
==========================================
+ Coverage 72.95% 73.00% +0.04%
==========================================
Files 26 26
Lines 1838 1841 +3
Branches 347 347
==========================================
+ Hits 1341 1344 +3
Misses 394 394
Partials 103 103 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
added a commit
that referenced
this pull request
Dec 6, 2025
Member
Author
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. 🤖 Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
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.
No description provided.