Streamline docstrings and fix documentation rendering bugs - #234
Merged
Conversation
azrael417
marked this pull request as ready for review
August 4, 2026 06:24
albertocarpentieri
self-requested a review
August 4, 2026 06:55
albertocarpentieri
left a comment
Collaborator
There was a problem hiding this comment.
Can we add build/ and *.egg-info to the .gitignore?
albertocarpentieri
approved these changes
Aug 4, 2026
albertocarpentieri
left a comment
Collaborator
There was a problem hiding this comment.
All good, mostly docs and formatting
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.
Problem
Docstring conventions had drifted across the package, and a few inconsistencies were actually breaking autodoc output. Since the docs have not been published yet, this is a good time to
normalize them.
Changes
Rendering bugs (visible in the built HTML)
with no parameter table. Converted to NumPy style.
autodoc_inherit_docstrings = False.
Consistency (no rendering change)
Docs config
Testing
Full Sphinx build against the working tree: 0 warnings (down from 104 in nitpicky mode). Verified nitpicky is genuinely active by injecting a bogus reference — caught with the new config,
silent under -D nitpicky=0.
Rendered-output diff through napoleon is exactly 12 lines, all intended Returns changes — confirming the 237 colon and 63 underline edits are render-neutral. AST comparison with docstrings
stripped shows 0 non-docstring differences across all 27 files.
API / numerical behavior
None. Docstrings, docs/conf.py, and one cross-reference only; no code paths touched.