Skip to content

Commit 7cc70c6

Browse files
committed
Minor e3-pypi-closure --help improvement
1 parent 9952f33 commit 7cc70c6

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

src/e3/python/pypi.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,10 @@ def __init__(
388388
data is cached a maximum of 24h. The cache contains results of requests to
389389
PyPI.
390390
:param pypi_url: set Python package registry URL. Default is PyPI
391+
:param allowed_prerelease: list of package names authorized to be into
392+
pre-release.
393+
:param allowed_yanked: list of package names authorized to have yanked flags set
394+
to true (see: PEP_592).
391395
"""
392396
self.cache_file = cache_file
393397
self.cache_dir = cache_dir

src/e3/python/pypiscript.py

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,37 +64,40 @@ def main() -> None:
6464
m.argument_parser.description = DESCRIPTION.strip()
6565
m.argument_parser.add_argument("config_file", help="configuration files")
6666
m.argument_parser.add_argument(
67-
"--python3-version", help="Python 3 version (default:10)", type=int, default=10
67+
"--python3-version",
68+
type=int,
69+
default=10,
70+
help="python 3 version (default: %(default)s)",
6871
)
6972
m.argument_parser.add_argument("target_dir", help="target directory")
7073
m.argument_parser.add_argument(
71-
"--cache-dir", help="cache directory (default ./cache)", default="./cache"
74+
"--cache-dir", help="cache directory (default: %(default)s)", default="./cache"
7275
)
7376
m.argument_parser.add_argument(
7477
"--skip-repo-updates",
7578
action="store_true",
76-
help="Don't update clones in the cache",
79+
help="don't update clones in the cache",
7780
)
7881
m.argument_parser.add_argument(
7982
"--local-clones",
80-
help="Use local clones. When set look for git clones in a directory",
83+
help="use local clones. When set look for git clones in a directory",
8184
default=None,
8285
)
8386
m.argument_parser.add_argument(
8487
"--allow-prerelease",
8588
dest="allowed_prerelease",
86-
metavar="REQUIREMENT",
89+
metavar="PACKAGE",
8790
nargs="*",
8891
default=None,
89-
help="Allow to use pre-release version for some requirements",
92+
help="allow to use pre-release version for some requirements",
9093
)
9194
m.argument_parser.add_argument(
9295
"--allow-yanked",
9396
dest="allowed_yanked",
94-
metavar="REQUIREMENT",
97+
metavar="PACKAGE",
9598
nargs="*",
9699
default=None,
97-
help="Allow to use yanked version for some requirements",
100+
help="allow to use yanked version for some requirements (See: PEP_592)",
98101
)
99102
m.parse_args()
100103
assert m.args is not None

0 commit comments

Comments
 (0)