docs: fix Sphinx docstring formatting and reST syntax errors - #195
docs: fix Sphinx docstring formatting and reST syntax errors#195petercorke 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.
|
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! |
|
Merge-order suggestion across the currently open PRs, based on a full file-overlap check across all of them. Nothing here is a conflict with anything already merged — these are parallel PRs sharing some source files with each other, so a rebase will likely be needed wherever paths cross, regardless of order. Recommended order:
|
Fixes 19+ files with sphinx build warnings and documentation clarity issues. All changes are non-functional; improve rendering and consistency only.