docs: fix Sphinx docstring formatting and reST syntax errors#195
Open
petercorke wants to merge 1 commit into
Open
docs: fix Sphinx docstring formatting and reST syntax errors#195petercorke wants to merge 1 commit into
petercorke wants to merge 1 commit into
Conversation
- Fix LaTeX escaping in docstrings (add missing braces, convert to raw strings) - Correct reST indentation for documentation lists and notes - Fix code example imports and function references - Update cross-references using proper Sphinx format (:meth:, ~seealso:) - Fix parameter name references in docstrings (S→s, math.pi→np.pi) - Add missing type annotations in parameter documentation - Remove obsolete documentation files (classes-2d.rst, classes-3d.rst) - Improve reference formatting for external links Fixes 19+ files with sphinx build warnings and documentation clarity issues. All changes are non-functional; improve rendering and consistency only.
Collaborator
Author
|
Note that classes-2d/3d.rst, shown as deleted, are orphaned documentation stub files. They were likely used for autodoc generation but are no longer referenced in the main documentation structure (not included in any .rst index or toctree). |
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Fixes 19+ files with sphinx build warnings and documentation clarity issues. All changes are non-functional; improve rendering and consistency only.