Skip to content

docs(desiderata): bring up to date with the code, and add status markers - #885

Merged
petercorke merged 1 commit into
mainfrom
docs/desiderata-refresh
Oct 22, 2026
Merged

petercorke merged 1 commit into
mainfrom
docs/desiderata-refresh

Conversation

@petercorke

Copy link
Copy Markdown
Owner

What

desiderata.md states the design RTB should converge on, but some statements read as current fact and are not. This brings it up to date with the code for 1.5.0 and marks what is done, partial or an aspiration. Documentation only, no code or behavior changes.

Corrected

  • Class names: Link and Robot are the ETS-based classes (there is no ETSLink or ETSRobot), PoELink and PoERobot (not POE…), ets() (there is no to_ets_robot()), and DHRobot, PoERobot and URDFRobot derive from Robot. The section 4 table and the class diagram follow.
  • No unique sequential integer identifier for a link exists: links have names, and joints have jindex.
  • Rendering is Matplotlib and Swift. MeshCat and CoppeliaSim are aspirations (CoppeliaSim Connector backend #675).
  • End effectors: leaf links, but a robot also has a tool transform and may carry Gripper objects, which is an open question, Rethink how grippers are modeled, and pause gripper-related changes #884.
  • The numerical ikine_XX methods are in Robot, not BaseRobot.

Added

  • [done], [partial] and [aspiration] markers, and a note of the release it was last checked against.
  • The planar classes (Link2, Robot2, ET2, ETS2), the joint offset, merge/swap/replace, analytic IK for any six-joint arm, the three RNE implementations, and the limits of the compiled solvers on "symbolic-agnostic".
  • A section on what is not yet covered (grippers, mobile robots, backends), and an invitation to comment on Discussions and Issues rather than send PRs for design changes.

Checked

Each statement changed was checked against main. I did not check the mermaid diagrams render on GitHub.

🤖 Generated with Claude Code

Names: Link and Robot are the ETS-based classes (not ETSLink and ETSRobot),
PoELink and PoERobot (not POE...), ets() (not to_ets_robot()), and DHRobot,
PoERobot and URDFRobot derive from Robot.  The class diagram follows.

Corrected: the unique integer link identifier does not exist (links have
names, joints have jindex); rendering is Matplotlib and Swift, MeshCat and
CoppeliaSim are aspirations; end effectors are leaf links but there is also
a tool transform and Gripper objects (see #884); ikine is in Robot.

Added: [done]/[partial]/[aspiration] markers, the planar classes, the joint
offset and merge/swap/replace of an ETS, analytic IK, the three RNE
implementations, the limits of the compiled solvers on "symbolic-agnostic",
a section on what is not yet covered, and an invitation to comment.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

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.

@petercorke
petercorke enabled auto-merge (squash) October 22, 2026 06:28
@petercorke
petercorke merged commit 31d99a9 into main Oct 22, 2026
23 checks passed
@petercorke
petercorke deleted the docs/desiderata-refresh branch October 22, 2026 06:34
@github-actions github-actions Bot mentioned this pull request Oct 22, 2026
@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 (9402635) to head (8977cbc).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #885   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files        146     146           
  Lines      17295   17295           
=====================================
  Misses     17295   17295           

☔ 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.

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