Skip to content

docs: add note for zsh users to quote extras during pip install #10222

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

docs: add note for zsh users to quote extras during pip install #10222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,17 @@ so make sure that is on your `PATH` variable.

### Development version (git clone)

$ python3 -m pip install --user -e .
Copy link
Member

Choose a reason for hiding this comment

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

why add this command here? In terms of ordering, this does not make sense for this section.
The command already appears on line 107:

electrum/README.md

Line 107 in c1ab6cd

$ python3 -m pip install --user -e .


> **Note for zsh users:** If your shell is `zsh`, you might see
> `zsh: no matches found: .[fast]`
> when installing. To fix this, quote the extras like so:
>
> ```bash
> python3 -m pip install --user '.[fast]'
Copy link
Member

Choose a reason for hiding this comment

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

AFAICT all mentions of "pip install ..." with extras already has it quoted.
For example:

electrum/README.md

Line 26 in c1ab6cd

$ ELECTRUM_ECC_DONT_COMPILE=1 python3 -m pip install --user ".[gui,crypto]"

electrum/contrib/build-wine/README_windows.md

Line 19 in c1ab6cd

> python3 -m pip install --user -e ".[gui,crypto]"

electrum/contrib/osx/README_macos.md

Line 31 in c1ab6cd

$ python3 -m pip install --user -e ".[gui,crypto]"

If you find one that does not, you can add quotes at there.

Copy link
Member

Choose a reason for hiding this comment

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

I guess if you think that helps, we could quote even the lone dots. e.g.
$ python3 -m pip install --user -e "."

> ```


_(For OS-specific instructions, see [here for Windows](contrib/build-wine/README_windows.md),
and [for macOS](contrib/osx/README_macos.md))_

Expand Down