Update Backends: view/color, several robots in one scene, Swift defaults and notebook
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Fix drift found in wiki review: factual errors, remove ROS, migrate desiderata to Issues
Factual errors fixed:
- Dynamics.md: Link.friction(q) -> Link.friction(qd), friction is a function
of joint velocity not position
- Grippers.md: rewritten from a 2020/2021 "discussion document, not
implemented" framing to describe the actual shipped Gripper class and
robot.grippers list, with real examples from Frankie/Fetch
- Kinematics.md: the "robots with multiple end effectors" section called
this "just speculation so far" with a made-up API; fkine/ikine_* already
ship end=/start= kwargs for exactly this, documented instead
- Coding-conventions.md: import typos (`script` -> `scipy`, `ppt` -> `plt`,
a stray backtick) that didn't match the actual codebase convention
ROS backend, per explicit decision -- not done, unclear if/when it will be,
so drop all mention rather than document vapourware:
- Delete ROS.md entirely
- Backends.md: drop the ## ROS section
- Contributing.md, Background.md: drop ROS mentions
Desiderata migrated to GitHub Issues (#673-#677), same rationale as the
tech-debt.md -> Issues migration: a wiki page can't be closed when the work
lands, which is exactly how Grippers.md and the ROS/Contributing mismatch
went stale. Contributing.md's "What needs doing" and Backends.md's TODO
section now point at the issues instead of listing items inline.
Also: Background.md gets a currency footnote (Python version, LGTM
shutdown) rather than presenting 2020 design goals as current status;
Scene-graphs.md gets a "superseded by Swift/SpatialGeometry" note and
moves from "Development (current)" to "OLD" in the sidebar, since that's
what it actually is; Home.md's one-line landing page gets a real intro
with navigation pointers.
Rewrite Documentation-Style-Guide: numpy style -> reST style
The page described the NumPy docstring convention (Parameters/Returns
section headers) as current practice. The codebase has used reST-style
docstrings (:param:, :returns:) throughout for a long time -- this page
was just never updated to match. Rewritten per rvc-ecosystem/AGENTS.md
Sec 5 (Code Standards), the canonical source shared across RTB/MVTB/SMTB/
bdsim. Also corrected the "Restructured Text for Built Docs" section,
which described an autosummary/:toctree: stubs pattern that isn't
actually used anywhere in the current docs -- real pages use plain
automodule/autoclass.
Delete Coding-Standard.md, a 7-line page fully subsumed by the more
detailed Coding-conventions.md.
Updated Backends (markdown)
Updated Backends (markdown)
Updated Backends (markdown)
jhavl
committed
Nov 30, 2020
Updated Backends (markdown)
Updated Backends (markdown)
Updated Backends (markdown)
Updated Backends (markdown)
Created Backends (markdown)