-
Notifications
You must be signed in to change notification settings - Fork 3k
Fix VSCode settings generation command #4463
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.
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
base: main
Are you sure you want to change the base?
Conversation
Greptile OverviewGreptile SummaryFixed incorrect VSCode settings generation command in pip installation documentation. Changed from non-existent Key changes:
Confidence Score: 4/5
Important Files Changed
Sequence DiagramsequenceDiagram
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
|
There was a problem hiding this 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
kellyguo11
left a comment
There was a problem hiding this 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is ./ needed for windows?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really :)
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>
Description
VSCode settings generation command is not valid in the doc describing pip installation flow.
Fixes # (issue)
Suggested command
python -m isaaclab --generate-vscode-settingsdoes not work.Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there