docs: headless doc cleanup#6108
Conversation
Greptile SummaryThis follow-up PR addresses review comments from the merged headless-cleanup PR (#6102) by fixing documentation wording and shell-snippet formatting across four
Confidence Score: 5/5All four files are documentation only — no runtime code, configuration, or test logic is touched. The rewording correctly matches the commands shown, and removing trailing backslashes from the last line of multi-line shell blocks is the right fix. Every change is a straightforward documentation correction. The shell-snippet backslash removals and the prose rewords are all self-consistent and match the actual commands in context. There is nothing here that could regress behaviour. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR #6102 Headless Cleanup Merged] --> B[Review Comments Received]
B --> C{Change Type}
C --> D[hover_policy.rst\nRemove trailing backslashes\nfrom 3 shell snippets]
C --> E[hydra.rst\nReword 'headless mode'\n→ 'without selecting a visualizer']
C --> F[ovphysx/index.rst\nReword 'headless zero-action rollout'\n→ 'zero-action rollout without selecting a visualizer']
C --> G[save_camera_output.rst\nReword comment\n'headless mode' → 'no visualizer']
Reviews (1): Last reviewed commit: "docs: Address headless cleanup review co..." | Re-trigger Greptile |
There was a problem hiding this comment.
Documentation Review — PR #6108
Summary: This PR cleanly addresses the follow-up review comments from the headless cleanup effort. The changes are straightforward and correct.
✅ Trailing Backslash Fixes (hover_policy.rst)
All three dangling backslash removals are correct. The final argument in each multi-line shell command no longer carries a continuation character, which resolves potential copy-paste issues for users.
✅ Terminology Rewordings
The "headless mode" → "without selecting a visualizer" / "(no visualizer)" rewordings are consistent with the terminology direction established in the parent PR.
💬 Minor Observation
hydra.rst (line 51): The description says the command runs "without selecting a visualizer," but the example command itself (./isaaclab.sh train --rl_library sb3 --task=Isaac-Cartpole ...) does not explicitly pass a visualizer-related flag — it is simply the default behavior of isaaclab.sh train. Consider whether the phrasing could be simplified to just describe what the command demonstrates (Hydra overrides) without mentioning visualization at all, e.g.:
The above command will run training with the task
Isaac-Cartpoleand set theenv.actions.joint_effort.scaleparameter to 10.0 and theagent.seedparameter to 2024.
This avoids making any claim about visualizer behavior that depends on runtime context rather than the shown command.
Overall this is a clean follow-up. No RST formatting issues found, and no remaining stale headless references in the touched files. 🎉
Description
Follow-up to merged PR #6102. This addresses review comments that landed after the original documentation cleanup was merged:
headless modeprose in the Hydra docs to say the command runs without selecting a visualizer.--headlessis required.headless modetono visualizer.No new dependencies.
Fixes # N/A
Type of change
Screenshots
N/A.
Checklist
pre-commitchecks with./isaaclab.sh --formatsource/<pkg>/changelog.d/for every touched package (N/A, no package source touched)CONTRIBUTORS.mdor my name already exists there