Clarify how defaults work when building an index with tabix#2002
Open
daviesrob wants to merge 1 commit intosamtools:developfrom
Open
Clarify how defaults work when building an index with tabix#2002daviesrob wants to merge 1 commit intosamtools:developfrom
daviesrob wants to merge 1 commit intosamtools:developfrom
Conversation
As the tabix index builder does file format detection, it's a bit misleading to say that the default for, say, -b is always 4. Instead, add a paragraph to the help text and the man page explaining in more detail how the configuration options work.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As the
tabixindex builder does file format detection, it's a bit misleading to say that the default for, say,-bis always 4. Instead, add a paragraph to the help text and the man page explaining in more detail how the configuration options work.Fixes #1995 (tabix: ambiguous help for --end?)