docs: fix Windows batch inline comment syntax and add shorthand command

[sellai-youcef]

The Windows batch command in the installation docs had an inline
comment using :: which breaks the command when
copy-pasted:

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

In Windows batch, :: only works at the start of a line and not inline.

Fix: removed the inline comment and listed the shorthand as a separate line instead:

isaaclab.bat --install
isaaclab.bat -i

This is an updated version of #5104, following @kellyguo11's feedback to list the shorthand command separately rather than removing it entirely.

Fixes #5086

[isaaclab-review-bot]

✅ Isaac Lab Review Bot

PR #5740 - docs: fix Windows batch inline comment syntax and add shorthand command

Summary

This PR correctly fixes a documentation bug where an inline :: comment in Windows batch code would break when copy-pasted.

Changes Reviewed

• File: docs/source/setup/installation/include/src_build_isaaclab.rst
• Fix: Replaced invalid inline comment syntax with separate lines showing both the full flag and shorthand

Analysis

✅ Correct fix - In Windows batch files, :: is only valid as a comment at the start of a line, not inline. The original isaaclab.bat --install :: or "isaaclab.bat -i" would fail when executed.

✅ Clean solution - Listing both commands separately is clearer and more user-friendly than using comments.

✅ Addresses feedback - Follows @kellyguo11's guidance from #5104 to show the shorthand rather than remove it.

Verdict

LGTM 👍 - Simple, correct documentation fix. No issues found.

---

Automated review by Isaac Lab Review Bot

[greptile-apps]

Greptile Summary

This PR fixes a Windows batch documentation bug where :: or \"isaaclab.bat -i\" was used as an inline comment, which is invalid in .bat files and broke the command when copy-pasted. The fix splits the line into two separate commands to show both the long and short forms.

• Removes the broken inline :: comment from the isaaclab.bat --install line and adds isaaclab.bat -i as a standalone line, correctly following Windows batch comment rules.
• The Linux tab is unchanged and continues to use a valid # inline comment; consistency between the two tabs is now slightly different in style.

Confidence Score: 4/5

Safe to merge — changes one line of documentation with a well-understood batch scripting fix.

The change correctly removes the broken inline :: comment and presents both install forms. The only open question is whether two consecutive commands without any label could mislead users into running both; this is minor and does not affect runtime behavior.

docs/source/setup/installation/include/src_build_isaaclab.rst — the two-line alternative command block could benefit from a leading :: comment to clarify they are alternatives, not sequential steps.

Important Files Changed

Filename	Overview
docs/source/setup/installation/include/src_build_isaaclab.rst	Fixes broken Windows batch inline comment (:: or "...") that caused copy-paste failures; now lists --install and -i as separate lines, though no visual cue distinguishes them as alternatives rather than sequential commands.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens Windows installation docs] --> B[Sees install code block]
    B --> C{Before fix}
    B --> D{After fix}
    C --> E["isaaclab.bat --install :: or 'isaaclab.bat -i'"]
    E --> F["❌ Inline '::' breaks batch command\nCopy-paste fails"]
    D --> G["isaaclab.bat --install\nisaaclab.bat -i"]
    G --> H["✅ Valid batch syntax\nBoth alternatives visible"]

Loading

_{Reviews (1): Last reviewed commit: "docs: fix Windows batch inline comment s..." | Re-trigger Greptile}

[greptile-apps]

Alternatives may be mistaken for sequential commands

Listing isaaclab.bat --install and isaaclab.bat -i on consecutive lines in a code block, without any separator or comment, looks like two commands that should both be run. A reader copy-pasting the block would run the install script twice. The Linux tab at line 30 uses a shell comment (# or "./isaaclab.sh -i") to make it explicit they are alternatives — the Windows block could use a leading :: comment in the same spirit (e.g., :: or shorthand:), since :: at the start of a line is valid batch syntax as shown in the examples section below.