adjusted docstrings in steinbock reader py file#165
Merged
LucaMarconato merged 4 commits intoscverse:mainfrom Apr 30, 2026
Merged
adjusted docstrings in steinbock reader py file#165LucaMarconato merged 4 commits intoscverse:mainfrom
LucaMarconato merged 4 commits intoscverse:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #165 +/- ##
=======================================
Coverage 62.15% 62.15%
=======================================
Files 27 27
Lines 3181 3181
=======================================
Hits 1977 1977
Misses 1204 1204
🚀 New features to boost your workflow:
|
- Move notes into a proper NumPy `Notes` section (fixes RST render) - Fix typos: andata→anndata, adviced→advised - Correct adata.obs.images→adata.obs.image (verified from source) - Replace plain URL with RST hyperlink syntax - Clarify that only one masks dir is used at a time (controlled by labels_kind) - Specify *.ome.tiff image format (from SteinbockKeys.IMAGE_SUFFIX) - Explain the images.csv/--info mechanism with required columns and correct link to file types docs instead of preprocessing docs Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
4 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.
As discussed in here, I made a few comments in the docstrings of the steinbock reader to improve documentation and possibly also improvements to the code.
Also tagging @melonora here as we will sit together and have a look at how to improve flexibility or at least the documentation.