Enhance documentation about options for pyenv virtualenv (#425)

pylipp · native-api · web-flow · commit 177eb67af3a9 · 2022-10-12T22:12:21.000+03:00
Co-authored-by: Ivan Pozdeev &lt;vano@mail.mipt.ru&gt;
diff --git a/README.md b/README.md
@@ -99,6 +99,9 @@ $ pyenv virtualenv 2.7.10 my-virtual-env-2.7.10
 will create a virtualenv based on Python 2.7.10 under `$(pyenv root)/versions` in a
 folder called `my-virtual-env-2.7.10`.
 
+`pyenv virtualenv` forwards any options to the underlying command that actually
+creates the virtual environment (`conda`, `virtualenv`, or `python -m venv`).
+See the output of `pyenv virtualenv --help` for details.
 
 ### Create virtualenv from current version
 
diff --git a/bin/pyenv-virtualenv b/bin/pyenv-virtualenv
@@ -6,7 +6,11 @@
 #        pyenv virtualenv --version
 #        pyenv virtualenv --help
 #
-#   -f/--force       Install even if the version appears to be installed already
+#   -f/--force       Install even if the version appears to be installed already. Skip
+#                    prompting for confirmation
+#
+# Notable VIRTUALENV_OPTIONS passed to venv-creating executable, if applicable:
+#   -u/--upgrade     Imply --force
 #
 
 PYENV_VIRTUALENV_VERSION="1.1.5"

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,11 @@`
`6`	`6`	`# pyenv virtualenv --version`
`7`	`7`	`# pyenv virtualenv --help`
`8`	`8`	`#`
`9`		`-# -f/--force Install even if the version appears to be installed already`
	`9`	`+# -f/--force Install even if the version appears to be installed already. Skip`
	`10`	`+# prompting for confirmation`
	`11`	`+#`
	`12`	`+# Notable VIRTUALENV_OPTIONS passed to venv-creating executable, if applicable:`
	`13`	`+# -u/--upgrade Imply --force`
`10`	`14`	`#`
`11`	`15`
`12`	`16`	`PYENV_VIRTUALENV_VERSION="1.1.5"`