Repository navigation
Conversation
- README and a comment in Serializable._update_kwargs referred to _KEYWORD_ALIASES; the attribute the code reads is _SERIALIZABLE_KEYWORD_ALIASES. - Serializable docstrings described PyEnsembl objects, a Genome, and a VariantCollection, and said a user-defined to_dict is required even though a default is provided. - Drop the Python 2 pickling comment in __reduce__. - Fix typos in README and helpers.to_dict. - Bump version to 1.1.1. Claude-Session: https://claude.ai/code/session_01DctgBZ5rJiuNzpWXqrNguT
Coverage Report for CI Build 34868032726Coverage remained the same at 89.778%Details
Uncovered ChangesNo uncovered changes found. Coverage Regressions7 previously-covered lines in 1 file lost coverage.
Coverage Stats
💛 - Coveralls |
iskandr
added a commit
that referenced
this pull request
Oct 6, 2026
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
added a commit
that referenced
this pull request
Oct 6, 2026
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 * Fix two more inaccurate docstrings from #14 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_01JRDMg3F5kNKmnjv5jvQBgr Claude-Session: https://claude.ai/code/session_01JyZ1WTFWJ3EZ41QdYzKwGP
Collaborator
Author
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.
This PR only changes docs and docstrings.
README.mdtold users to define_KEYWORD_ALIASES, and so did the comment inSerializable._update_kwargs. The code reads only_SERIALIZABLE_KEYWORD_ALIASES(serializable.py:83,dataclass_serializable.py:74), so following the README silently did nothing. Both now use the correct name.Serializabledocstrings called it the "base class for all PyEnsembl objects" and describedto_json,write_json_file, andread_json_fileas working on a Genome or VariantCollection. They now describe generic objects.to_dictis required, butSerializable.to_dicthas a default. It now says only that theto_dict()keys must match the__init__arguments.__reduce__explaining a Python 2 pickling limitation.helpers.to_dict.Checks:
./lint.shand./test.shpass (42 tests).https://claude.ai/code/session_01DctgBZ5rJiuNzpWXqrNguT