Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sellai-youcef wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/setup/installation/include/src_build_isaaclab.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Installation

.. code:: batch

isaaclab.bat --install :: or "isaaclab.bat -i"
isaaclab.bat --install
isaaclab.bat -i
Comment on lines +37 to +38
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot May 22, 2026

Choose a reason for hiding this comment

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

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



All core submodules are **always** installed regardless of what is passed to ``-i``.
Expand Down