Skip to content

Fixes windows batch command inline comment syntax #5104

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 2 commits into
base: main
Choose a base branch
from
+2 −2
Open

Fixes windows batch command inline comment syntax #5104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b2a625
docs: fix batch command syntax in src_build_isaaclab.rst
sellai-youcef Mar 24, 2026
32389b3
Merge branch 'main' into fix-windows-install-docs
sellai-youcef Apr 8, 2026
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
4 changes: 2 additions & 2 deletions 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 @@ -26,7 +26,7 @@ Installation

.. code:: batch

isaaclab.bat --install :: or "isaaclab.bat -i"
isaaclab.bat --install
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 24, 2026

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.



By default, the above will install **all** the learning frameworks. These include
Expand All @@ -50,7 +50,7 @@ Installation

.. code:: batch

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

The valid options are ``all``, ``rl_games``, ``rsl_rl``, ``sb3``, ``skrl``, ``robomimic``,
and ``none``. If ``none`` is passed, then no learning frameworks will be installed.