docs: fix code examples for setting-up-ide
and interpreter-compatibility
docs (Cherry-pick of #19624)
#19695
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Setting Up IDE Doc Issue
Currently, in the
docs/markdown/Using Pants/setting-up-an-ide.md
page, the project instructs users to runHowever, for some reason, the command
pants roots --roots-sep=' '
is not working for the' '
character. This PR makes a small fix to this issue changing the' '
character to the default'\n'
by removing the--roots-sep=
argument and changing how theROOTS
environment variable is split.Alternatively, if we want to maintain the
roots-sep
argument, so users know it exists, we can change it from' '
to a non whitespace character, such as';'
and that also seems to work.Interpreter Compatibility Doc Issue
Another small issue is in
docs/markdown/Python/python/python-interpreter-compatibility.md
in the example:This example is missing an
}
. This PR also addresses this small issue.