Skip to content

Conversation

@myurasov-nv
Copy link

@myurasov-nv myurasov-nv commented Jan 27, 2026

Description

VSCode settings generation command is not valid in the doc describing pip installation flow.

Fixes # (issue)

Suggested command python -m isaaclab --generate-vscode-settings does not work.

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • (NA?) I have added tests that prove my fix is effective or that my feature works
  • (NA?) I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions bot added bug Something isn't working documentation Improvements or additions to documentation labels Jan 27, 2026
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 27, 2026

Greptile Overview

Greptile Summary

Fixed incorrect VSCode settings generation command in pip installation documentation. Changed from non-existent python -m isaaclab --generate-vscode-settings to the correct platform-specific commands: ./isaaclab.sh --vscode for Linux and ./isaaclab.bat --vscode for Windows.

Key changes:

  • Replaced single command with tab-set showing platform-specific commands (Linux/Windows)
  • Updated command to use existing shell script flags verified in isaaclab.sh:738 and isaaclab.bat:630
  • Added contributor name to CONTRIBUTORS.md
  • Minor formatting issues: extra leading space on line 108 and stray - character on line 124

Confidence Score: 4/5

  • Safe to merge after addressing minor formatting issues
  • The core fix is correct and necessary - the old command doesn't exist. The new commands are verified to work in the codebase. Only minor formatting issues (extra space and stray dash) need cleanup.
  • docs/source/setup/installation/isaaclab_pip_installation.rst needs minor formatting cleanup before merge

Important Files Changed

Filename Overview
docs/source/setup/installation/isaaclab_pip_installation.rst Fixed VSCode settings command, but has minor formatting issues (extra leading space and stray dash)
CONTRIBUTORS.md Added contributor name in alphabetically correct position

Sequence Diagram

sequenceDiagram
    participant User
    participant Documentation
    participant Shell Script
    participant Python Script
    
    User->>Documentation: Read pip installation guide
    Documentation->>User: Shows VSCode settings command
    
    alt Linux
        User->>Shell Script: ./isaaclab.sh --vscode
        Shell Script->>Python Script: Execute .vscode/tools/setup_vscode.py
        Python Script->>Python Script: Generate .vscode/settings.json
        Python Script-->>User: VSCode settings created
    else Windows
        User->>Shell Script: ./isaaclab.bat --vscode
        Shell Script->>Python Script: Execute .vscode/tools/setup_vscode.py
        Python Script->>Python Script: Generate .vscode/settings.json
        Python Script-->>User: VSCode settings created
    end
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Copy link
Contributor

@kellyguo11 kellyguo11 left a comment

Choose a reason for hiding this comment

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

Thanks for the fix - the doc build job seems to be failing. The greptile comments look valid as well

CONTRIBUTORS.md Outdated
* Weihua Zhang
* Tsz Ki GAO
* Anke Zhao
* Mikhail Yurasov
Copy link
Contributor

Choose a reason for hiding this comment

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

this should be in alphabetical order

python -m isaaclab --generate-vscode-settings
.. code-block:: cmd
./isaaclab.bat --vscode
Copy link
Contributor

Choose a reason for hiding this comment

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

is ./ needed for windows?

Copy link
Author

Choose a reason for hiding this comment

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

Not really :)

myurasov-nv and others added 4 commits January 26, 2026 20:48
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants