Add documentation for all VariantHeader related classes#1394
Merged
jmarshall merged 2 commits intoApr 25, 2026
Conversation
This was referenced Mar 10, 2026
jmarshall
force-pushed
the
td_add-variant-header-docs
branch
from
a5e9f72 to
8b6a6ab
Compare
Don't use "Returns" for properties, because they just *are* a value rather than being functions returning a value. Revert BaseIndex.get() to the original text, as I suspect this method doesn't work at all.
jmarshall
approved these changes
Apr 25, 2026
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.
Summary
This PR adds VCF documentation for the following classes:
Notes
This PR is based on #1361, Github unfortunately does not allow stacking PRs from external branches cleanly. Please review documentation PRs in the following order: #1358, #1359, #1361, #1394. I can rebase after each merge.