Fix docs: #128 #129 #133 #135#146
Merged
Merged
Conversation
- LocusRead.reference_positions: base-1 → base-0 (#128) - run_isovar docstring: fix param name decompress_threads → decompression_threads, fix return type "Generator" → "list of IsovarResult" (#129) - README: protein_sequence_matches_predicted_effect → protein_sequence_matches_predicted_mutation_effect (#133) - DataFrameBuilder.exclude docstring: "should be used" → "should be omitted" (#135) Fixes #128, #129, #133, #135
|
coverage: 93.127%. remained the same — fix-docs-128-129-133-135 into master |
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
Combined documentation fix PR:
LocusRead.reference_positionsdocstring corrected from base-1 to base-0.run_isovardocstring fixed param name (decompress_threads→decompression_threads) and return type ("Generator" → "list of IsovarResult").protein_sequence_matches_predicted_effect→protein_sequence_matches_predicted_mutation_effect.DataFrameBuilder.excludedocstring corrected from "should be used" to "should be omitted".Fixes #128, #129, #133, #135
Test plan
./test.shpasses (158 tests)./lint.shpasses