From 85ce052d60aadb4fce779c404c052074bc530fbc Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Mon, 18 Sep 2023 16:55:13 +0200 Subject: [PATCH] docs(config): fix default value for install_command (#3126) The `install_command` config is documented as having the default value: python -I -m pip install 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 '' '' '.[test]' ERROR: Invalid requirement: '' Adjust the documentation to use the replaceable variables: `{opts}` and `{packages}`. --- docs/changelog/3126.doc.rst | 1 + docs/config.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 docs/changelog/3126.doc.rst diff --git a/docs/changelog/3126.doc.rst b/docs/changelog/3126.doc.rst new file mode 100644 index 000000000..f7e25a143 --- /dev/null +++ b/docs/changelog/3126.doc.rst @@ -0,0 +1 @@ +Fix default value for ``install_command`` - by :user:`hashar`. diff --git a/docs/config.rst b/docs/config.rst index b567f70dc..2dd7e43b1 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -795,7 +795,7 @@ Pip installer .. conf:: :keys: install_command - :default: python -I -m pip install + :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