Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inconsistent wording in pipx install command description #1307

Merged
merged 3 commits into from
Mar 28, 2024

Conversation

sgryjp
Copy link
Contributor

@sgryjp sgryjp commented Mar 28, 2024

  • I have added a news fragment under changelog.d/ (if the patch affects the end users)

Summary of changes

This PR changes the word PACKAGE_NAME to PACKAGE_SPEC in the description of pipx install command:

pipx install PACKAGE_NAME ...
pipx install --python PYTHON PACKAGE_NAME
...(snip)...

The PACKAGE_SPEC argument is passed directly to `pip install`.
...(snip)...

positional arguments:
  package_spec          package name(s) or pip installation spec(s)

I believe that the name of positional argument(s) of pipx install command should be package_spec since argparse is configured with that name.

Test plan

Tested by running:

$ pipx install -h | grep -c PACKAGE_NAME
0

@sgryjp sgryjp marked this pull request as ready for review March 28, 2024 03:13
@dukecat0 dukecat0 merged commit 9fafc97 into pypa:main Mar 28, 2024
14 checks passed
@sgryjp sgryjp deleted the fix-inconsistent-wording branch March 28, 2024 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants