fix(docs): fix intro.rst syntax errors, dangling section, and stale claims#549
Merged
Conversation
…laims 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>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #549 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 136 136
Lines 13438 13438
=====================================
Misses 13438 13438 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Summary
Critical review of
intro.rst(a lightly-adapted ICRA2021 paper) found real bugs beyond staleness:DHRobot([...])examples (inert::blocks, never executed/caught by Sphinx)ikine_LMconverges for all 200 poses)Plus a staleness pass, each claim checked against the actual codebase rather than assumed:
pyproject.toml)coal(matches the already-tracked tech-debt.md item), with a Windows-wheel-availability notelgtm.comclaim (confirmed dead — no lgtm/CodeQL anywhere in.github/workflows/)ROS.py's methods are literallysuper().stepwith no parens,# pragma nocover; Dynamixel has noConnectorsubclass at all) — correctly left as "under development"Test plan
🤖 Generated with Claude Code