Skip to content

Fixes windows batch command inline comment syntax#5104

Open
sellai-youcef wants to merge 1 commit intoisaac-sim:mainfrom
sellai-youcef:fix-windows-install-docs
Open

Fixes windows batch command inline comment syntax#5104
sellai-youcef wants to merge 1 commit intoisaac-sim:mainfrom
sellai-youcef:fix-windows-install-docs

Conversation

@sellai-youcef
Copy link
Copy Markdown

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

Signed-off-by: sellai-youcef <sellaiyoucefs@gmail.com>
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 24, 2026

Greptile Summary

This PR fixes broken Windows batch command examples in the installation docs by removing invalid inline :: comments that caused copy-pasted commands to fail. In Windows CMD/batch, :: is a label syntax valid only at the start of a line; using it after a command (isaaclab.bat --install :: or "...") silently breaks the command.

Key changes:

  • isaaclab.bat --install :: or "isaaclab.bat -i"isaaclab.bat --install
  • isaaclab.bat --install rl_games :: or "isaaclab.bat -i rl_games"isaaclab.bat --install rl_games

The Linux equivalents (using # for inline bash comments) are correctly left untouched.

Minor follow-up opportunity: the removed comments also served to document the -i shorthand alias, which is now only visible in the Linux tab. A small prose note could re-surface this information for Windows users.

Confidence Score: 5/5

  • Safe to merge — purely a docs fix that corrects actively broken command examples.
  • The change is a minimal, targeted documentation fix with no code logic involved. The root cause (inline :: in batch) is well-understood and correctly addressed. The only follow-up item is a non-blocking docs improvement suggestion.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/source/setup/installation/include/src_build_isaaclab.rst Removes broken inline :: comments from two Windows batch code blocks; the fix is correct and doesn't affect any logic. Minor: the -i shorthand hint is no longer visible to Windows users.

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 &quot;isaaclab.bat -i&quot;"]
    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]
Loading

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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 -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.

@kellyguo11 kellyguo11 changed the title docs: fix windows batch command inline comment syntax Fixes windows batch command inline comment syntax Mar 29, 2026
Copy link
Copy Markdown

@isaaclab-review-bot isaaclab-review-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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 -i shorthand 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Proposal] Installation docs update for Windows pre-built binaries

1 participant