Subcommands main parser help changes #324

mauvilsa · 2023-07-14T02:29:02Z

What does this PR do?

Set notation of subcommands choices now only included in usage.
In subcommands section, now each subcommand is always shown separately, including the name, and if available aliases and help.
When default_env=True include subcommand environment variable name.

Before submitting

Did you read the contributing guideline?
Did you update the documentation? (readme and public docstrings)
Did you write unit tests such that there is 100% coverage on related code? (required for bug fixes and new features)
Did you verify that new and existing tests pass locally?
Did you make sure that all changes preserve backward compatibility?
Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

codecov · 2023-07-14T21:45:07Z

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (748543d) 100.00% compared to head (61ff8bb) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #324   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines         5522      5528    +6     
=========================================
+ Hits          5522      5528    +6

Flag	Coverage Δ
py3.10	`86.54% <100.00%> (+0.01%)`	⬆️
py3.10_all	`98.33% <100.00%> (+<0.01%)`	⬆️
py3.10_types	`98.33% <100.00%> (+<0.01%)`	⬆️
py3.11	`86.52% <100.00%> (+0.01%)`	⬆️
py3.11_all	`98.31% <100.00%> (+<0.01%)`	⬆️
py3.11_types	`98.31% <100.00%> (+<0.01%)`	⬆️
py3.6	`85.95% <100.00%> (+0.01%)`	⬆️
py3.6_all	`97.81% <100.00%> (+<0.01%)`	⬆️
py3.7	`87.94% <100.00%> (+0.01%)`	⬆️
py3.7_all	`99.47% <100.00%> (+<0.01%)`	⬆️
py3.7_types	`99.45% <100.00%> (+<0.01%)`	⬆️
py3.8	`88.11% <100.00%> (+0.01%)`	⬆️
py3.8_all	`99.51% <100.00%> (+<0.01%)`	⬆️
py3.8_types	`99.49% <100.00%> (+<0.01%)`	⬆️
py3.9	`88.04% <100.00%> (+0.01%)`	⬆️
py3.9_all	`99.54% <100.00%> (+<0.01%)`	⬆️
py3.9_types	`99.54% <100.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
jsonargparse/_actions.py	`100.00% <100.00%> (ø)`
jsonargparse/_formatters.py	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Set notation of subcommands choices now only included in usage. - In subcommands section, now each subcommand is always shown separately, including the name, and if available aliases and help. - When default_env=True include subcommand environment variable name.