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

defaults not listed in cli docs #130

Open
nick-youngblut opened this issue Jan 16, 2022 · 0 comments
Open

defaults not listed in cli docs #130

nick-youngblut opened this issue Jan 16, 2022 · 0 comments

Comments

@nick-youngblut
Copy link

For much of the cli help docs, the defaults are not included. For example:

Heuristic Detector Options:
  --min-frequency MIN_FREQUENCY
                        Minimum frequency required to retain a k-mer.
  --min-contaminant-match-frac MIN_CONTAMINANT_MATCH_FRAC
                        Minimum fraction of nucleotides that must align for a
                        detected contaminant to match a known adapter
                        sequence.

Why now use an argparse formatter that automatically lists the defaults? For example:

class CustomFormatter(argparse.ArgumentDefaultsHelpFormatter,
                      argparse.RawDescriptionHelpFormatter):
    pass

parser = argparse.ArgumentParser(description=desc, formatter_class=CustomFormatter)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant