Skip to content

Commit

Permalink
Improve clarity of help text for options supporting multiple (#1492)
Browse files Browse the repository at this point in the history
  • Loading branch information
AndydeCleyre committed Sep 28, 2021
1 parent 4b3a673 commit 388589b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
12 changes: 7 additions & 5 deletions piptools/scripts/compile.py
Expand Up @@ -75,13 +75,13 @@ def _get_default_option(option_name: str) -> Any:
"--extra",
"extras",
multiple=True,
help="Names of extras_require to install",
help="Name of an extras_require group to install; may be used more than once",
)
@click.option(
"-f",
"--find-links",
multiple=True,
help="Look for archives in this directory or on this HTML page",
help="Look for archives in this directory or on this HTML page; may be used more than once",
)
@click.option(
"-i",
Expand All @@ -91,7 +91,9 @@ def _get_default_option(option_name: str) -> Any:
),
)
@click.option(
"--extra-index-url", multiple=True, help="Add additional index URL to search"
"--extra-index-url",
multiple=True,
help="Add another index URL to search; may be used more than once",
)
@click.option("--cert", help="Path to alternate CA bundle.")
@click.option(
Expand All @@ -103,7 +105,7 @@ def _get_default_option(option_name: str) -> Any:
"--trusted-host",
multiple=True,
help="Mark this host as trusted, even though it does not have "
"valid or any HTTPS.",
"valid or any HTTPS; may be used more than once",
)
@click.option(
"--header/--no-header",
Expand Down Expand Up @@ -142,7 +144,7 @@ def _get_default_option(option_name: str) -> Any:
"upgrade_packages",
nargs=1,
multiple=True,
help="Specify particular packages to upgrade.",
help="Specify a particular package to upgrade; may be used more than once",
)
@click.option(
"-o",
Expand Down
11 changes: 8 additions & 3 deletions piptools/scripts/sync.py
Expand Up @@ -48,16 +48,21 @@
"-f",
"--find-links",
multiple=True,
help="Look for archives in this directory or on this HTML page",
help="Look for archives in this directory or on this HTML page; may be used more than once",
)
@click.option("-i", "--index-url", help="Change index URL (defaults to PyPI)")
@click.option(
"--extra-index-url", multiple=True, help="Add additional index URL to search"
"--extra-index-url",
multiple=True,
help="Add another index URL to search; may be used more than once",
)
@click.option(
"--trusted-host",
multiple=True,
help="Mark this host as trusted, even though it does not have valid or any HTTPS.",
help=(
"Mark this host as trusted, even though it does not have valid or any HTTPS"
"; may be used more than once"
),
)
@click.option(
"--no-index",
Expand Down

0 comments on commit 388589b

Please sign in to comment.