Skip to content
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

[Documentation] Fix quotes for windows installations #19859

Merged
merged 3 commits into from
Oct 29, 2021

Conversation

pcmoritz
Copy link
Contributor

Why are these changes needed?

Escaping on the windows shell with ' doesn't work, we need to use ". Otherwise you get an error like

ERROR: Invalid requirement "'ray[default]'"

or

ERROR: Invalid requirement "'ray[rllib]'"

or

ERROR: Invalid requirement "'ray[tune]'"

or

ERROR: Invalid requirement "'ray[serve]'"

or

ERROR: Invalid requirement "'ray[data]'"

Related issue number

Checks

  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@richardliaw
Copy link
Contributor

Looks good, will have to have Eric/Chen sign off.

@ericl
Copy link
Contributor

ericl commented Oct 29, 2021

We don't actually need quotes right? It would be better to remove them entirely from the command examples.

@pcmoritz
Copy link
Contributor Author

pcmoritz commented Oct 29, 2021

There are some shells that need quotes, like zsh which is the standard in macOS:

(base) ➜  ray git:(master) ✗ pip install ray[rllib]
zsh: no matches found: ray[rllib]

I think using " to quote is the safest and works on all platforms (bash on linux, zsh on macOS and cmd on windows).

Copy link
Contributor

@scv119 scv119 left a comment

Choose a reason for hiding this comment

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

LGTM

@pcmoritz pcmoritz merged commit 0a5942d into ray-project:master Oct 29, 2021
@pcmoritz pcmoritz deleted the windows-fix-doc-quotes branch October 29, 2021 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants