Skip to content

docs: one style for docstring section headings, and 1.5.0 for the next release - #882

Merged
petercorke merged 2 commits into
mainfrom
docs/section-headings-and-versions
Oct 22, 2026
Merged

petercorke merged 2 commits into
mainfrom
docs/section-headings-and-versions

Conversation

@petercorke

Copy link
Copy Markdown
Owner

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/ and docs/source/)

  • Examples is .. rubric:: Examples, always plural: 99 underlined NumPy-style headings converted, and the 2 singular .. rubric:: Example in the docs. Notes (78) and References (43) already used rubrics, so there is now one mechanism for every heading, and it does not depend on napoleon reading NumPy sections.
  • See Also is .. 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.
  • Left alone: the underlined Parameters and Returns sections (44), which are old NumPy-style and need to be rewritten as :param: and :returns: by hand, a separate pass.

Version numbers

  • 1.4.5 is 1.5.0: 19 versionchanged, 18 deprecated, and the prose, a comment and a test docstring that name it, and the jtraj deprecation message ("deprecated in 1.5.0"; no test matches that text). The current release is 1.4.4, so 1.4.5 never shipped.
  • 1.6.0 is 1.5.0: four versionadded notices for the analytic IK, which is on main and unreleased. CHANGELOG.md is generated by release-please and is not touched.

Also

  • The replace() example in ETS (feat(ets): replace() and replaced() put a transform on another axis #874) was missing from roboticstoolbox import ET in its second block, which the docs build reports as a runblock error. Fixed.
  • AGENTS.md states 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 main and 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 the replace() 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

…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
petercorke enabled auto-merge (squash) October 21, 2026 23:45
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

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

codecov Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (f7d5548) to head (cabc21f).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@petercorke
petercorke merged commit 6497cdc into main Oct 22, 2026
23 checks passed
@github-actions github-actions Bot mentioned this pull request Oct 22, 2026
@petercorke
petercorke deleted the docs/section-headings-and-versions branch October 22, 2026 04:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant