filter: Improve help text #1430
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
victorlin
force-pushed
the
victorlin/filter-help-text
branch
from
348613b to
592447e
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## victorlin/filter-max-length #1430 +/- ##
============================================================
Coverage 68.66% 68.66%
============================================================
Files 69 69
Lines 7554 7555 +1
Branches 1851 1851
============================================================
+ Hits 5187 5188 +1
Misses 2089 2089
Partials 278 278 ☔ View full report in Codecov by Sentry. |
- Capitalize beginning of sentences and use periods at the end. - Suppress defaults where the value is none/false. - Add more meaningful metavars.
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").
Add reference to --metadata-id-columns which affects the behavior of these options.
victorlin
force-pushed
the
victorlin/filter-help-text
branch
from
080b61c to
a64c3e0
Compare
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Several touch-ups to improve the clarity of the help text shown when running
augur filter --helpand rendered on the docs page (preview).Related issue(s)
Checklist