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

filter: Improve help text #1430

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

filter: Improve help text #1430

wants to merge 7 commits into from

Commits on Mar 6, 2024

  1. Add test to show help text

    @victorlin
    victorlin committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    020b360 View commit details
    Browse the repository at this point in the history

  2. Make --query-columns help text deterministic

    @victorlin
    victorlin committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    9884fa1 View commit details
    Browse the repository at this point in the history

  3. Wrap lines to be more readable

    @victorlin
    victorlin committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    ae38452 View commit details
    Browse the repository at this point in the history

  4. Improve help text 

    - Capitalize beginning of sentences and use periods at the end.
- Suppress defaults where the value is none/false.
- Add more meaningful metavars.
    @victorlin
    victorlin committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    2c86dc7 View commit details
    Browse the repository at this point in the history

  5. Consistently use strain to refer to data 

    Other ways of saying this were 'sequence' and 'sample'. Note that
'sequence' is left as-is for the help text of sequence filters (e.g.
"length of the sequences").
    @victorlin
    victorlin committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    8204764 View commit details
    Browse the repository at this point in the history

  6. Clarify behavior for options that use strain ID 

    Add reference to --metadata-id-columns which affects the behavior of
these options.
    @victorlin
    victorlin committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    e3832f1 View commit details
    Browse the repository at this point in the history

  7. Update changelog

    @victorlin
    victorlin committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    a64c3e0 View commit details
    Browse the repository at this point in the history