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.

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

minor UI issue: "parser" specific options are not listed in --help #21

Open
yarikoptic opened this issue Jul 2, 2020 · 3 comments
Open
Labels
help wanted Extra attention is needed

Comments

@yarikoptic
Copy link
Member

e.g.

$> tributors init zenodo       
Please provide the zenodo doi with --doi

but

$> tributors init zenodo --help
usage: tributors init [-h] [--force] [--repo REPO]
                      [{zenodo,allcontrib,codemeta,all} [{zenodo,allcontrib,codemeta,all} ...]]

positional arguments:
  {zenodo,allcontrib,codemeta,all}
                        Metadata file parsers to update or initialize.

optional arguments:
  -h, --help            show this help message and exit
  --force               If exists, overwrite existing .all-contributorsrc
  --repo REPO           The repository URI, if not exported to GITHUB_REPOSITORY

I guess --help could list options for all the parsers and annotate to which any applies?

@vsoch
Copy link
Collaborator

vsoch commented Jul 2, 2020

If you want to address this you can take a shot, but this is intentional because they aren't actually options, they are parsed from "extra." I've created very detailed tables of options in the docs as a workaround / helper to that.

@yarikoptic
Copy link
Member Author

Why not to move those tables to --help output or ideally reuse for both --help and docs (bigger undertaking, IMHO not immediately needed). FWIW, not directly related, in DataLad we came up with similarish setups for "cmdline" and "Python" examples which are listed in --help and also rendered in the docs, see e.g. https://github.com/datalad/datalad/blob/HEAD/datalad/distribution/install.py#L99

But again - it is a "minor UI issue" so let's just keep it in mind for now.

@vsoch vsoch added the help wanted Extra attention is needed label Jul 2, 2020
@vsoch
Copy link
Collaborator

vsoch commented Jul 2, 2020

Yeah, these variables are hugely un-likely to be used in the first place (mostly updating filename defaults that will never change) so I'm not going to volunteer to do this issue. But if this is important to you, feel free to take a shot / PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants