Improve API docs for bgzf_mt #1556
Merged
Conversation
This file contains 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
Note that this now works on reading as well as writing. Removed the comment about only when compiled with -DBGZF_MT as this was misleading implying the user has to adjust CFLAGS. It's on by default and there's nothing the user can do to turn it off without manually editing bgzf.c, in which case they're on their own. Also document that n_sub_blks now does nothing. Fixes samtools#1553
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.
Note that this now works on reading as well as writing.
Removed the comment about only when compiled with
-DBGZF_MTas this was misleading implying the user has to adjust CFLAGS. It's on by default and there's nothing the user can do to turn it off without manually editing bgzf.c, in which case they're on their own.Also document that n_sub_blks now does nothing.
Fixes #1553