diff options
| author | Matthew Feickert <matthew.feickert@cern.ch> | 2023-02-20 19:25:04 -0700 |
|---|---|---|
| committer | Matthew Feickert <matthew.feickert@cern.ch> | 2023-03-14 00:22:15 -0500 |
| commit | 9a82bdfc527391bb306fc70814977a14e184f946 (patch) | |
| tree | b21a89e45a773174bbe4c89493c604714aee0136 /docs | |
| parent | 83c800d3b8b367b6ae1fbf92fd4f699612cecfc7 (diff) | |
| download | pip-9a82bdfc527391bb306fc70814977a14e184f946.tar.gz | |
Quote extras to guard shells with glob qualifiers
* Shells like zsh have glob qualifiers that will error if an extra
is not quoted. While the glob qualifiers can be disabled, adding
quotes guards against errors if people are copy-pasting or do not
know that they can disable the behavior.
* Use single quotes for Linux/Mac and use double quotes for Windows
to follow existing style conventions.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/html/cli/pip_install.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/html/cli/pip_install.rst b/docs/html/cli/pip_install.rst index 7c17c264a..6e517c0fd 100644 --- a/docs/html/cli/pip_install.rst +++ b/docs/html/cli/pip_install.rst @@ -386,21 +386,21 @@ Examples .. code-block:: shell - python -m pip install SomePackage[PDF] - python -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@main#subdirectory=subdir_path" - python -m pip install .[PDF] # project in current directory - python -m pip install SomePackage[PDF]==3.0 - python -m pip install SomePackage[PDF,EPUB] # multiple extras + python -m pip install 'SomePackage[PDF]' + python -m pip install 'SomePackage[PDF] @ git+https://git.repo/SomePackage@main#subdirectory=subdir_path' + python -m pip install '.[PDF]' # project in current directory + python -m pip install 'SomePackage[PDF]==3.0' + python -m pip install 'SomePackage[PDF,EPUB]' # multiple extras .. tab:: Windows .. code-block:: shell - py -m pip install SomePackage[PDF] + py -m pip install "SomePackage[PDF]" py -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@main#subdirectory=subdir_path" - py -m pip install .[PDF] # project in current directory - py -m pip install SomePackage[PDF]==3.0 - py -m pip install SomePackage[PDF,EPUB] # multiple extras + py -m pip install ".[PDF]" # project in current directory + py -m pip install "SomePackage[PDF]==3.0" + py -m pip install "SomePackage[PDF,EPUB]" # multiple extras #. Install a particular source archive file. |