Skip to content

[MINOR] Add quotes to fix erroneous pip install command in SDP Prog Guide#54955

Open
suhuruli wants to merge 2 commits intoapache:masterfrom
suhuruli:fix-typo-in-sdp-programming-guide
Open

[MINOR] Add quotes to fix erroneous pip install command in SDP Prog Guide#54955
suhuruli wants to merge 2 commits intoapache:masterfrom
suhuruli:fix-typo-in-sdp-programming-guide

Conversation

@suhuruli
Copy link

What changes were proposed in this pull request?

  • Add quotes around the pip install command in the SDP Programming Guide.

Why are the changes needed?

  • In the programming guide, the pip install pyspark[pipelines] command errors out on Mac Terminal without quotes. The quotes don't affect the command on other bash terminals while ensuring it works on the Mac Terminal OOB.
  • Also just affects the latest Spark version since SDP is in 4.1.x.

Does this PR introduce any user-facing change?

How was this patch tested?

  • Simple docs change, tested markdown rendering to ensure no styling errors were found

Was this patch authored or co-authored using generative AI tooling?

  • No

@gaogaotiantian
Copy link
Contributor

I think this is a good change. zsh does not take raw [] well so it breaks without quotes. Other projects (FastAPI, pandas) are using quotes in their docs too. It's easier for the users to just copy/paste the line without investigating failures.

However, I think if we are trying to fix it, we should fix them all. I did a quick search in our docs and found a few other places that use pip install pyspark[*] without quotes. @suhuruli could you fix them all?

@suhuruli
Copy link
Author

Happy to go fix this everywhere and update my PR!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants