Skip to content

Commit

Permalink
cli: improve help text
Browse files Browse the repository at this point in the history
Added examples of argparse-compatible configuration settings
and harmonised option formatting.

Ref: pypa#205
  • Loading branch information
layday committed Jan 15, 2021
1 parent 88ee1fe commit bfaaf6c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/build/__main__.py
Expand Up @@ -128,7 +128,7 @@ def main_parser(): # type: () -> argparse.ArgumentParser
'--sdist',
'-s',
action='store_true',
help='build a source package',
help='build a source distribution',
)
parser.add_argument(
'--wheel',
Expand All @@ -139,15 +139,14 @@ def main_parser(): # type: () -> argparse.ArgumentParser
parser.add_argument(
'--outdir',
'-o',
metavar='dir',
type=str,
help='output directory (defaults to {{srcdir}}{sep}dist)'.format(sep=os.sep),
)
parser.add_argument(
'--skip-dependencies',
'-x',
action='store_true',
help='does not check for the dependencies',
help='do not check that build dependencies are installed',
)
parser.add_argument(
'--no-isolation',
Expand All @@ -159,7 +158,8 @@ def main_parser(): # type: () -> argparse.ArgumentParser
'--config-setting',
'-C',
action='append',
help='pass option to the backend',
help='pass options to the backend. Options which begin with a hyphen must be in the form of '
'`--config-setting=--opt` or `-C--opt`',
)
return parser

Expand Down

0 comments on commit bfaaf6c

Please sign in to comment.