(feat): composable API for xarray dataset #1997
Open
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
…to ig/setting_on_dataset
ilan-gold
changed the title
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1997 +/- ##
==========================================
- Coverage 87.14% 85.21% -1.94%
==========================================
Files 46 46
Lines 6986 7033 +47
==========================================
- Hits 6088 5993 -95
- Misses 898 1040 +142
🚀 New features to boost your workflow:
|
…to ig/setting_on_dataset
…anndata into ig/composition_over_inheritance
Co-authored-by: Philipp A. <[email protected]>
Co-authored-by: Philipp A. <[email protected]>
flying-sheep
requested changes
Jun 6, 2025
docs/conf.py
Outdated
Comment on lines
96
to
103
| nitpick_ignore_regex = [ | ||
| # See https://github.com/python/cpython/blob/7775d93e2d142ab66c7d8fa7cff068b2522a37b0/Lib/_collections_abc.py#L792-L817 | ||
| # for why these are necessary. | ||
| # The docstrings are just normal strings and thus misinterpreted. | ||
| # TODO: revert once this is resolved in python. | ||
| ("py:class", ".*d defaults to None.*"), | ||
| ("py:class", "a.*object providing.*a view on D.*"), | ||
| ] |
There was a problem hiding this comment.
The fact that these strings end up in our docs at all is the problem, so instead of ignoring errors arising from that, please prevent the source of the issue
- either by not creating documentation for inherited methods (e.g. like this), and instead linking to
Mappingand explaining that we inherit from it (e.g. setting"show-inheritance": Trueinautodoc_default_options) - or by overriding them with our own docstrings
Suggested change
| nitpick_ignore_regex = [ | |
| # See https://github.com/python/cpython/blob/7775d93e2d142ab66c7d8fa7cff068b2522a37b0/Lib/_collections_abc.py#L792-L817 | |
| # for why these are necessary. | |
| # The docstrings are just normal strings and thus misinterpreted. | |
| # TODO: revert once this is resolved in python. | |
| ("py:class", ".*d defaults to None.*"), | |
| ("py:class", "a.*object providing.*a view on D.*"), | |
| ] |
ilan-gold
commented
Jun 6, 2025
…anndata into ig/composition_over_inheritance
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.
Following up on a conversation with Luca, a composable API is like both more maintainable and more explainable. It also represents a concrete step towards something like #1111. This PR represents a first step as it forces us to more clearly enumerate the methods needed for internal compatibility that were hidden by subclassing from
Dataseti.e.,copyandreindex