Fixes windows batch command inline comment syntax#5104
Fixes windows batch command inline comment syntax#5104sellai-youcef wants to merge 1 commit intoisaac-sim:mainfrom
Conversation
Signed-off-by: sellai-youcef <sellaiyoucefs@gmail.com>
Greptile SummaryThis PR fixes broken Windows batch command examples in the installation docs by removing invalid inline Key changes:
The Linux equivalents (using Minor follow-up opportunity: the removed comments also served to document the Confidence Score: 5/5
Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User copies batch command from docs] --> B{Inline :: comment present?}
B -- Yes/Old --> C["isaaclab.bat --install :: or "isaaclab.bat -i""]
C --> D[CMD interprets :: as label syntax]
D --> E[Command fails / unexpected behavior]
B -- No/Fixed --> F[isaaclab.bat --install]
F --> G[Command executes correctly]
Reviews (1): Last reviewed commit: "docs: fix batch command syntax in src_bu..." | Re-trigger Greptile |
| .. code:: batch | ||
|
|
||
| isaaclab.bat --install :: or "isaaclab.bat -i" | ||
| isaaclab.bat --install |
There was a problem hiding this comment.
-i shorthand no longer documented for Windows
The removed inline comments also served as documentation for the -i shorthand alias. Windows users reading only the Windows tab will no longer see that -i is equivalent to --install. Consider adding a small prose note after the code blocks (similar to how the Linux tab keeps # or "./isaaclab.sh -i") so this information isn't silently lost.
For example, the surrounding paragraph could be updated to read:
Run the install command … using pip (with ``--editable`` flag).
You can also use the shorthand ``-i`` flag, e.g. ``isaaclab.bat -i``.
This is not blocking — the primary fix is correct — but it's worth preserving the originally conveyed information.
There was a problem hiding this comment.
🤖 Isaac Lab Review Bot — PR #5104
Summary
Removes broken inline comments (:: or "isaaclab.bat -i") from two Windows batch code blocks in the installation docs. In Windows batch, :: is a label-based comment mechanism that only works as a standalone line — it cannot be used inline after a command. When users copy-pasted these code blocks, the :: and trailing text were passed as extra arguments to isaaclab.bat, causing errors.
The Linux (bash) equivalents correctly use # for inline comments, which is valid syntax. This PR removes the problematic Windows inline comments entirely rather than attempting to fix the syntax (e.g., &::), which is the cleaner approach recommended in the linked issue #5086.
Design Assessment
- Approach: Remove the inline comments rather than fix them — correct choice. The comments were redundant (the
-ishorthand is documented elsewhere) and any batch inline comment syntax (&::,& REM) would look noisy in a docs code block. - Scope: Exactly the two affected lines, nothing more.
Implementation Verdict
✅ LGTM — Straightforward, correct docs fix.
Findings
No issues found. The change is minimal, accurate, and directly addresses the copy-paste breakage described in #5086.
ℹ️ CI Status: No checks reported on this branch. This is a docs-only change to an RST file, so no functional CI is expected.
Reviewed at commit 8b2a625.
The Windows batch commands in the installation docs had inline comments
using
::which cause errors when copy-pasted:isaaclab.bat --install :: or "isaaclab.bat -i"
The
::is not valid as an inline comment in batch — it breaks the command.Fix: removed the inline comments, keeping only the clean commands:
isaaclab.bat --install
isaaclab.bat --install rl_games
Fixes #5086