Skip to content

Commit

Permalink
docs(config): fix default value for install_command (#3126)
Browse files Browse the repository at this point in the history
The `install_command` config is documented as having the default value:

  python -I -m pip install <opts> <packages>

The last two arguments are not substituable and are thus passed as is
(eg as packages to install) resulting in:

  py3-test: install_deps> python -I -m pip install -v '<opts>'
  '<packages>' '.[test]'
  ERROR: Invalid requirement: '<opts>'

Adjust the documentation to use the replaceable variables: `{opts}` and
`{packages}`.
  • Loading branch information
hashar authored Sep 18, 2023
1 parent 9429881 commit 85ce052
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/changelog/3126.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix default value for ``install_command`` - by :user:`hashar`.
2 changes: 1 addition & 1 deletion docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ Pip installer

.. conf::
:keys: install_command
:default: python -I -m pip install <opts> <packages>
:default: python -I -m pip install {opts} {packages}
:version_added: 1.6

Determines the command used for installing packages into the virtual environment; both the package under test and its
Expand Down

0 comments on commit 85ce052

Please sign in to comment.