Skip to content

Commit de2ea5f

Browse files
committed
main: improve help text
Closes #613.
1 parent e6d0616 commit de2ea5f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/build/__main__.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,7 @@ def main_parser() -> argparse.ArgumentParser:
313313
'-o',
314314
type=str,
315315
help=f'output directory (defaults to {{srcdir}}{os.sep}dist)',
316+
metavar='PATH',
316317
)
317318
parser.add_argument(
318319
'--skip-dependency-check',
@@ -324,14 +325,18 @@ def main_parser() -> argparse.ArgumentParser:
324325
'--no-isolation',
325326
'-n',
326327
action='store_true',
327-
help='do not isolate the build in a virtual environment',
328+
help='disable building the project in an isolated virtual environment. '
329+
'Build dependencies must be installed separately when this option is used',
328330
)
329331
parser.add_argument(
330332
'--config-setting',
331333
'-C',
332334
action='append',
333-
help='pass options to the backend. options which begin with a hyphen must be in the form of '
334-
'"--config-setting=--opt(=value)" or "-C--opt(=value)"',
335+
help='settings to pass to the backend. Multiple settings can be provided. '
336+
'Settings beginning with a hyphen will erroneously be interpreted as options to build if separated '
337+
'by a space character; use `--config-setting=--my-setting -C--my-other-setting`',
338+
metavar='KEY[=VALUE]',
339+
)
335340
)
336341
return parser
337342

0 commit comments

Comments
 (0)