Fix: stale API usage in the teleop session doc - #1009
Conversation
Signed-off-by: Xinghua Sun <xinghuas@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. 📝 WalkthroughWalkthroughThe teleoperation guide now uses configured left-hand Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to This documentation-only update corrects stale teleoperation examples and configuration references; no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches 💡 1⚔️ Resolve merge conflicts 💡
🧪 Generate unit tests (beta)
Comment |
Description
The Python blocks in
docs/source/getting_started/teleop_session.rstpredated the single-sidedGripperRetargeterand theTensorGroupinput contract, so several of them raised on the first call rather than being merely imprecise. A reader copying the Quick Start got anImportError; a reader copying the "Before" block got three different exceptions in sequence.Quick Start
GripperRetargetermoved toisaacteleop.retargetersand now requires aGripperRetargeterConfiggripper_command, notgripper_left/gripper_rightBefore vs After
oxr.OpenXRSession.create(...)does not exist — construct the class directlyControllerTracker, so take it fromcontrollers.get_tracker(); a standalonedeviceio.ControllerTracker()is never registered with the session and raisesRuntimeError: Tracker implementation not foundTensorGroups —poll_tracker()replaces the hand-built dict of lists, which raisedAttributeError: 'list' object has no attribute 'group_type'Also
OpenXRSessionHandlesimport path:teleopcore.oxr->isaacteleop.oxr(teleopcoreis not importable)teleop_control_pipelineandsinksfields to theTeleopSessionConfiglistingType of change
Testing
Every code block was extracted into a scratch harness and executed against a live
CloudXR session (CloudXR Runtime 6.3.0,
Quest3device profile, web-client emulator),rather than only checked against the source. Each block ran with a bounded loop and
exited 0.
Not covered: the
pm.PluginManager([...])/plugin_manager.start(...)lines in the"Before" block remain
...placeholders in a deliberately schematic section, and werenot executed.
Platform: Ubuntu, Python 3.11.15, isaacteleop 1.5.115rc1.
Checklist
SKIP=check-copyright-year pre-commit run --all-filesgit commit -s) per the DCOSummary by CodeRabbit