Add documentation for all VariantRecord related classes
#1359
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
TimD1
changed the title
VariantRecord related classesVariantRecord related classes
TimD1
force-pushed
the
td_add-variant-record-docs
branch
from
1b8370b to
2774a7f
Compare
jmarshall
reviewed
Sep 30, 2025
|
|
||
| if index < 0 or index >= n: | ||
| raise IndexError('invalid filter index') | ||
| raise IndexError('Invalid filter index.') |
There was a problem hiding this comment.
More than 95% of the error strings in both the Python stdlib and pysam don't have a trailing fullstop, so that's the convention I'd like to follow. I'm on board with capitalising these sentences, but let's leave them without a final period/fullstop.
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.
This includes the following small classes which were previously missing documentation:
Documentation for
VariantRecordSamplewas more extensive, and introduced in a previous MR: #1358