Skip to content

Commit 4752b37

Browse files
michaelsakijsf9k
andauthored
Improve verbiage in comments
Co-authored-by: Shane Frasier <[email protected]>
1 parent 495862a commit 4752b37

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ There are a few ways to do this, but we prefer to use
4646
create and manage a Python virtual environment specific to this
4747
project.
4848

49-
The `setup-env` tool in this repository is our recommended method
50-
for automating the entire environment configuration process. The
49+
We recommend using the `setup-env` tool located in this repository,
50+
as it automates the entire environment configuration process. The
5151
dependencies required to run this tool are
5252
[GNU `getopt`](https://github.com/util-linux/util-linux/blob/master/misc-utils/getopt.1.adoc),
5353
[`pyenv`](https://github.com/pyenv/pyenv), and [`pyenv-virtualenv`](https://github.com/pyenv/pyenv-virtualenv).

setup-env

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Options:
2727
-h | --help Show this message.
2828
-i | --install-hooks Install hook environments for all environments in the
2929
pre-commit config file.
30-
-l | --list-versions List available Python versions and select interactively.
30+
-l | --list-versions List available Python versions and select one interactively.
3131
-v | --venv-name Specify the name of the virtual environment.
3232
-p | --python-version Specify the Python version for the virtual environment.
3333
@@ -63,7 +63,7 @@ if [[ $(getopt --version 2> /dev/null) != *"getopt from util-linux"* ]]; then
6363
are not supported by the POSIX getopt found in some systems, particularly
6464
those with a non-GNU version of getopt. This distinction is crucial
6565
as a system might have a non-GNU version of getopt installed by default,
66-
which could lead to unexpected behavior or script failure.
66+
which could lead to unexpected behavior.
6767
6868
On the Mac, we recommend installing brew (https://brew.sh/). Then installation
6969
is as simple as `brew install gnu-getopt` and adding this to your

0 commit comments

Comments
 (0)