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

README.md: Update install steps to escape brackets #298

Merged
merged 1 commit into from
Jan 23, 2024

Conversation

daverigby
Copy link
Contributor

@daverigby daverigby commented Jan 23, 2024

Problem

Some shells (e.g. zsh) treat the '[]' in the argument as a shell expansion, and fail to pass the correct argument to pip:

% pip3 install pinecone-client[grpc] 
zsh: no matches found: pinecone-client[grpc]

Solution

Fix by quoting the package name.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

Test Plan

Confirmed install still works with zsh and bash on macOS.

Some shells (e.g. zsh) treat the '[]' in the argument as a shell expansion, and fail to pass the correct argument to pip:

    % pip3 install pinecone-client[grpc] 
    zsh: no matches found: pinecone-client[grpc]

Fix by quoting the package name.
@daverigby daverigby requested a review from jhamon January 23, 2024 09:23
@jhamon jhamon merged commit 2a7faa8 into main Jan 23, 2024
64 checks passed
@jhamon jhamon deleted the daverigby-pip-zsh-escape branch January 23, 2024 16:08
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.

None yet

2 participants