Update help docs to clarify multiple version(s) are allowed (#1197)

* Update help docs to clarify multiple version(s) are allowed

* Tweek version(s) help description
This commit is contained in:
Brian Dowling 2020-03-19 17:35:46 -04:00 committed by GitHub
parent 89786b909f
commit a8ca63fcc0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 35 additions and 14 deletions

View file

@ -1,16 +1,24 @@
#!/usr/bin/env bash
#
# Summary: Set or show the global Python version
# Summary: Set or show the global Python version(s)
#
# Usage: pyenv global <version>
# Usage: pyenv global <version> <version2> <..>
#
# Sets the global Python version. You can override the global version at
# Sets the global Python version(s). You can override the global version at
# any time by setting a directory-specific version with `pyenv local'
# or by setting the `PYENV_VERSION' environment variable.
#
# <version> should be a string matching a Python version known to pyenv.
# The special version string `system' will use your default system Python.
# Run `pyenv versions' for a list of available Python versions.
# <version> can be specified multiple times and should be a version
# tag known to pyenv. The special version string `system' will use
# your default system Python. Run `pyenv versions' for a list of
# available Python versions.
#
# Example: To enable the python2.7 and python3.7 shims to find their
# respective executables you could set both versions with:
#
# 'pyenv global 3.7.0 2.7.15'
#
set -e
[ -n "$PYENV_DEBUG" ] && set -x

View file

@ -1,11 +1,11 @@
#!/usr/bin/env bash
#
# Summary: Set or show the local application-specific Python version
# Summary: Set or show the local application-specific Python version(s)
#
# Usage: pyenv local <version>
# Usage: pyenv local <version> <version2> <..>
# pyenv local --unset
#
# Sets the local application-specific Python version by writing the
# Sets the local application-specific Python version(s) by writing the
# version name to a file named `.python-version'.
#
# When you run a Python command, pyenv will look for a `.python-version'
@ -15,9 +15,16 @@
# `PYENV_VERSION' environment variable takes precedence over local
# and global versions.
#
# <version> should be a string matching a Python version known to pyenv.
# The special version string `system' will use your default system Python.
# Run `pyenv versions' for a list of available Python versions.
# <version> can be specified multiple times and should be a version
# tag known to pyenv. The special version string `system' will use
# your default system Python. Run `pyenv versions' for a list of
# available Python versions.
#
# Example: To enable the python2.7 and python3.7 shims to find their
# respective executables you could set both versions with:
#
# 'pyenv local 3.7.0 2.7.15'
set -e
[ -n "$PYENV_DEBUG" ] && set -x

View file

@ -1,7 +1,7 @@
#!/usr/bin/env bash
# Summary: Show the current Python version and its origin
# Summary: Show the current Python version(s) and its origin
#
# Shows the currently selected Python version and how it was
# Shows the currently selected Python version(s) and how it was
# selected. To obtain only the version string, use `pyenv
# version-name'.

View file

@ -6,6 +6,7 @@
#
# Displays the full path to the executable that pyenv will invoke when
# you run the given command.
#
set -e
[ -n "$PYENV_DEBUG" ] && set -x
@ -82,6 +83,8 @@ else
echo "The \`$1' command exists in these Python versions:"
echo "$versions" | sed 's/^/ /g'
echo
echo "Note: See 'pyenv help global' for tips on allowing both"
echo " python2 and python3 to be found."
} >&2
fi

View file

@ -107,6 +107,9 @@ pyenv: py.test: command not found
The \`py.test' command exists in these Python versions:
3.3
3.4
Note: See 'pyenv help global' for tips on allowing both
python2 and python3 to be found.
OUT
}