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

upgrade command-line docs for sourmash sig subcommands #1612

Closed
ctb opened this issue Jun 20, 2021 · 3 comments · Fixed by #1714
Closed

upgrade command-line docs for sourmash sig subcommands #1612

ctb opened this issue Jun 20, 2021 · 3 comments · Fixed by #1714
Labels
good second issue Second-tier issues for newer developers! repeatable quest Issues with many, many subtasks; good for people new to codebase.

Comments

@ctb
Copy link
Contributor

ctb commented Jun 20, 2021

The various sourmash sig subcommands (cat, extract, etc) do not give very useful information when invoked on the command line without any arguments --

% sourmash sig cat
usage:  cat [-h] [-q] [-o FILE] [-u] signatures [signatures ...]
 cat: error: the following arguments are required: signatures

to address this:

  • pick a sourmash sig subcommand that doesn't have useful output when run w/o arguments
  • find the relevant subcommand file (e.g. src/sourmash/cli/sig/cat.py)
  • in that file, add a description=__doc__ and usage=usage argument to the subparser.add_parser(...) call; see src/sourmash/compute.py for an example
  • initialize the __doc__ and usage strings from the command-line docs
  • ask for initial review and someone will work with you on the text

This can also be done for many other commands than just the sourmash sig, too ;).

@ctb ctb added repeatable quest Issues with many, many subtasks; good for people new to codebase. good second issue Second-tier issues for newer developers! labels Jun 20, 2021
@ctb
Copy link
Contributor Author

ctb commented Jun 26, 2021

relevant: #899

@keyabarve
Copy link
Contributor

@ctb Can I work on this issue?

@ctb
Copy link
Contributor Author

ctb commented Aug 11, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good second issue Second-tier issues for newer developers! repeatable quest Issues with many, many subtasks; good for people new to codebase.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants