You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(docs): fix intro.rst syntax errors, dangling section, and stale claims (#549)
Bugs (not just staleness):
- Two missing-comma syntax errors in DHRobot() link-list examples (plain
:: literal blocks, never executed by Sphinx, so never caught).
- The "Straight line (Cartesian) paths" runblock was fully commented out
but the prose after it still referenced specific line numbers of the
invisible code. Re-enabled with a working example (verified: seeded
batch ikine_LM call converges for all 200 poses) and rewrote the prose
to match the actual output.
- Two literal blocks (closest_point example, default plot() example)
weren't indented relative to their introducing paragraph, so per reST
rules they rendered as plain text instead of code.
- A stray duplicated sentence fragment and two accidental blank lines
splitting a sentence mid-word in the opening history paragraph.
Staleness (checked against the actual codebase, not assumed):
- Python version claims updated 3.6 -> 3.10 (three places), matching
pyproject.toml's requires-python.
- PyBullet -> coal: the toolbox switched collision backends; added a
Windows-wheel-availability note matching tech-debt.md's already-tracked
item.
- Removed the lgtm.com "automated code review" claim -- confirmed no
lgtm/CodeQL references anywhere in .github/workflows/; the service
doesn't exist in this repo's actual CI today.
- Conclusion's "currently under development" list: mobile robotics
motion models/planners/EKF/SLAM are confirmed shipped (mobile/__init__.py
has 8+ planners, EKF, ParticleFilter, all wired into the public API) --
moved out of the pending list. ROS/Dynamixel backends were initially
assumed shipped too (files exist with real line counts) but on closer
inspection are non-functional stubs (ROS.py's methods are literally
`super().step` with no parens -- not even calling the parent -- and
`# pragma nocover`; Dynamixel has no Connector subclass at all) --
correctly left in the "under development" list.
- "over 30 robot models" -> "over 50" (actual count: DH=24, URDF=24,
ETS=7).
Verified: full docs build still succeeds at the same 5-warning baseline
as before these changes; full test suite 653 passed, 13 skipped, no
regressions.
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
.. [Featherstone87] R. Featherstone, Robot Dynamics Algorithms. Kluwer Academic, 1987.
774
778
.. [Corke07] P. Corke, `“A simple and systematic approach to assigning Denavit- Hartenberg parameters,” IEEE transactions on robotics, vol. 23, no. 3, pp. 590–594, 2007, DOI 10.1109/TRO.2007.896765. <https://ieeexplore.ieee.org/document/4252158>`_.
775
779
.. [Haviland20] `J. Haviland and P. Corke, “A systematic approach to computing the manipulator Jacobian and Hessian using the elementary transform sequence,” arXiv preprint, 2020. <https://arxiv.org/abs/2010.08696>`_
0 commit comments