Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Functional-oriented argparse groups #305

Closed
maciej-lech opened this issue Mar 29, 2020 · 2 comments · Fixed by #442
Closed

Functional-oriented argparse groups #305

maciej-lech opened this issue Mar 29, 2020 · 2 comments · Fixed by #442
Labels
enhancement Good first issue help wanted

Comments

@maciej-lech
Copy link
Contributor

The idea is to have functional-oriented argparse groups.

How would this feature be useful?
It will increase the readability of the help message.

Describe the solution you'd like
Instead of having primary/additinal argparse groups we can split the arguments into more functional-oriented groups e.g.:

  • general: --help, --version, --verbose, --noxfile, posargs
  • reporting: --nocolor, --forcecolor, --report
  • collection: --list, --session, --keywords
  • environment: --envdir, --reuse-existing-virtualenvs, etc.
  • execution: --stop-on-first-error, --install-only, --non-interactive, etc.

I based above on pytest --help
@maciej-lech maciej-lech mentioned this issue Mar 29, 2020
Closed
@theacodes
Copy link
Collaborator

I'm all for this and it would be a good first issue for someone to tackle

@DrGFreeman
Copy link
Contributor

Hello, I'd like to work on this issue if it's OK. Thx.

DrGFreeman added a commit to DrGFreeman/nox that referenced this issue Jun 10, 2021
@DrGFreeman
Group CLI arguments in functional groups (wntrblm#305)
c4d05e4 
Replace the primary/secondary argparse argument groups with functional
groups:
  - general
  - sessions
  - python
  - environment
  - execution
  - reporting
@DrGFreeman DrGFreeman mentioned this issue Jun 10, 2021
Merged
DrGFreeman added a commit to DrGFreeman/nox that referenced this issue Jun 11, 2021
@DrGFreeman
Re-organize groups and display names (wntrblm#305)
cadda3e 
Move the --non-interactive option in the execution group and shorten the
group display names.
DrGFreeman added a commit to DrGFreeman/nox that referenced this issue Jun 11, 2021
@DrGFreeman
Group CLI arguments in functional groups (wntrblm#305)
1bd1153 
Replace the primary/secondary argparse argument groups with functional
groups:
  - general
  - sessions
  - python
  - environment
  - execution
  - reporting
cjolowicz pushed a commit that referenced this issue Jun 11, 2021
@DrGFreeman
Group CLI arguments in functional groups (#305) (#442)
0fb841d
@mlech-reef mlech-reef mentioned this issue Oct 16, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Good first issue help wanted
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Group CLI arguments in functional groups DrGFreeman/nox
3 participants
@theacodes @maciej-lech @DrGFreeman