Skip to content

Installation guide - replace curly bracket with parantheses#5046

Open
smollerNV wants to merge 1 commit intoisaac-sim:mainfrom
smollerNV:patch-1
Open

Installation guide - replace curly bracket with parantheses#5046
smollerNV wants to merge 1 commit intoisaac-sim:mainfrom
smollerNV:patch-1

Conversation

@smollerNV
Copy link

To correctly set the path for the environment variable, the pwk command must be enclosed in parantheses rather than curly brackets.

Type of change

  • Documentation update

This is the correct way to make it execute the command.

Signed-off-by: smollerNV <164020096+smollerNV@users.noreply.github.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 17, 2026
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 17, 2026

Greptile Summary

This PR fixes a bash syntax bug in the source installation guide. The export ISAACSIM_PATH line previously used "${pwd}/_build/linux-x86_64/release", which performs variable expansion on a variable named pwd (which is empty by default), resulting in a broken path. The fix correctly uses "$(pwd)/_build/linux-x86_64/release", which performs command substitution — executing the pwd command to obtain the current working directory.

  • Fixes ${pwd}$(pwd) on the ISAACSIM_PATH export line in the Linux tab of the installation guide
  • The Windows equivalent (%cd%) in the same file was already correct and is unchanged
  • The fix is accurate and matches the intended behavior described in the PR

Confidence Score: 5/5

  • This PR is safe to merge — it is a correct, minimal documentation fix with no risk.
  • The change is a single-line correction of a bash syntax error in a .rst documentation file. It introduces no logic changes, no new dependencies, and the fix ($(pwd) vs ${pwd}) is unambiguously correct for bash command substitution.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/source/setup/installation/source_installation.rst Corrects bash command substitution syntax from ${pwd} (variable expansion) to $(pwd) (command substitution) when setting ISAACSIM_PATH.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["User runs: export ISAACSIM_PATH=..."] --> B{Syntax used}
    B -- "Before: \${pwd}" --> C["Shell looks up variable 'pwd'\n(empty string by default)"]
    C --> D["ISAACSIM_PATH = '/_build/linux-x86_64/release'\n❌ Broken path"]
    B -- "After: \$(pwd)" --> E["Shell executes 'pwd' command\nreturns current directory"]
    E --> F["ISAACSIM_PATH = '/home/user/isaac-sim/_build/linux-x86_64/release'\n✅ Correct path"]
Loading

Last reviewed commit: bc41ffc

@myurasov-nv
Copy link
Collaborator

@smollerNV I think it makes more sense to add this to develop branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants