Repository navigation
Fix docstrings copied from sibling packages; bump to 1.1.2 - #18
Merged
Merged
Conversation
Coverage Report for CI Build 37522069925Warning Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes. Coverage increased (+2.2%) to 92.0%Details
Uncovered ChangesNo uncovered changes found. Coverage Regressions3 previously-covered lines in 1 file lost coverage.
Coverage Stats
💛 - Coveralls |
This was referenced Oct 6, 2026
iskandr
force-pushed
the
fix-generic-docstrings
branch
from
October 6, 2026 16:56
ef8cf34 to
9ec4a04
Compare
iskandr
changed the title
Serializable's inherited docstrings named VariantCollection, Genome and PyEnsembl, which leaked into downstream API docs (e.g. PyEnsembl's Genome.read_json_file). Make them generic, and fix a code comment that still named the old `_KEYWORD_ALIASES` hook. Adds a write_json_file/read_json_file round-trip test (previously uncovered). Fixes #17 Claude-Session: https://claude.ai/code/session_01JRDMg3F5kNKmnjv5jvQBgr
Serializable provides a default to_dict, so it doesn't need a user-defined one; also fix the grammar in to_serializable_repr's helper docstring. Claude-Session: https://claude.ai/code/session_01JyZ1WTFWJ3EZ41QdYzKwGP
iskandr
force-pushed
the
fix-generic-docstrings
branch
from
October 6, 2026 19:51
e1cf7f3 to
5eb7c8b
Compare
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
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.
Fixes #17. Stacked on #19 (the base will retarget to
masterwhen #19 merges).Serializable.write_json_file/read_json_filesaid "VariantCollection",to_jsonsaid "Genome", and the class docstring said "PyEnsembl objects". Every subclass inherits these, so they showed up in downstream rendered docs (e.g. PyEnsembl'sGenome.read_json_file). They're generic now. Also fixes a code comment that still named the old_KEYWORD_ALIASEShook.Serializableclass docstring said subclasses need a user-definedto_dict(there's a default one), and theto_serializable_reprhelper docstring had a garbled sentence ("wasn't isn't").write_json_file→read_json_fileround-trip test; those two methods had no coverage.The README fix this PR originally carried (
_KEYWORD_ALIASES→_SERIALIZABLE_KEYWORD_ALIASES) is already in #19, so the rebase dropped it.https://claude.ai/code/session_01JRDMg3F5kNKmnjv5jvQBgr