Repository navigation
docs: one style for docstring section headings, and 1.5.0 for the next release - #882
Merged
Merged
Conversation
…t release Examples is a .. rubric:: (99 were underlined NumPy sections), See Also is .. seealso:: (44), and :seealso: (219) is the directive: it is not a Sphinx field, and it rendered as one more labelled field after the parameters, not as a See also box. The version notices that said 1.4.5 or 1.6.0 say 1.5.0: 1.4.5 never shipped (the current release is 1.4.4) and the 1.6.0 notices are for work that is in 1.5.0. The deprecation message in jtraj says 1.5.0. The replace() example in ETS needed its import, which the build reported as a runblock error. AGENTS.md says what the convention is. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
petercorke
enabled auto-merge (squash)
October 21, 2026 23:45
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #882 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 146 146
Lines 17164 17164
=====================================
Misses 17164 17164 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Merged
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.
One style for the section headings of docstrings, and 1.5.0 for the next release. Mechanical, done with a script, 59 files.
Section headings (
src/anddocs/source/)Examplesis.. rubric:: Examples, always plural: 99 underlined NumPy-style headings converted, and the 2 singular.. rubric:: Examplein the docs.Notes(78) andReferences(43) already used rubrics, so there is now one mechanism for every heading, and it does not depend onnapoleonreading NumPy sections.See Alsois.. seealso::: 44 underlined sections converted.:seealso:is.. seealso::: 219 uses.:seealso:is not a Sphinx construct. I built it both ways: it renders as one more labelled field after the parameters and returns ("Seealso: g()"), whereas the directive renders the "See also" box. After the change there are 94 See also boxes in the sample I built, up from 38, and no "Seealso:" labels.ParametersandReturnssections (44), which are old NumPy-style and need to be rewritten as:param:and:returns:by hand, a separate pass.Version numbers
versionchanged, 18deprecated, and the prose, a comment and a test docstring that name it, and thejtrajdeprecation message ("deprecated in 1.5.0"; no test matches that text). The current release is 1.4.4, so 1.4.5 never shipped.versionaddednotices for the analytic IK, which is onmainand unreleased.CHANGELOG.mdis generated by release-please and is not touched.Also
replace()example inETS(feat(ets): replace() and replaced() put a transform on another axis #874) was missingfrom roboticstoolbox import ETin its second block, which the docs build reports as a runblock error. Fixed.AGENTS.mdstates the convention (rubric headings,.. seealso::, never:seealso:, and what a version notice names), so it stays one style.How it was checked. I built a sample of the documented modules (ETS, ET, RobotKinematics, Dynamics, IK, EKF, PlannerBase, PoseGraph, trajectory, DHRobot) with the real extensions (autodoc, napoleon, typehints, pyrunblock, plot) against
mainand against this branch: the same 58 warnings of the same kinds, so no new ones (the 32 "Explicit markup ends without a blank line" and the undefined labels are in both), and with thereplace()fix no runblock errors. Full test suite (2216 passed) and mypy (clean, 165 files).Changes numerical results or public behaviour: no. Documentation and one deprecation message.
Written with Claude Code.
🤖 Generated with Claude Code