Changelog and API reference follow-ups for the segmentation pipeline - #11
Merged
Conversation
Covers the segmentation module, the optional extra, the zarr store naming, and the tutorial notebook.
Documentation build overview
6 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11 +/- ##
=======================================
Coverage 65.90% 65.90%
=======================================
Files 13 13
Lines 1349 1349
=======================================
Hits 889 889
Misses 460 460 🚀 New features to boost your workflow:
|
It is a naming helper, not an entry point; the two functions above it are the documented surface.
rushin682
changed the title
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
1 participant
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.
Two documentation follow-ups to #10.
Changelog
The segmentation pipeline was never recorded in
CHANGELOG.md— neither #9, which added it, nor #10, which documented it.Adds bullets under
[Unreleased]→Added, matching the module-oriented style of the existing entries:spatialrefinery.segmentation— the InstanSeg nucleus segmentation and the SpatialData export, the optionalsegmentationextra, and theslide.ome.tif→slide.zarrstore namingNothing has been released yet, so these belong under
Addedrather thanChanged.API reference
Drops
default_zarr_pathfrom the Segmenting section ofdocs/api.md. It is a naming helper, not an entry point —segment_wsiandgeojson_to_spatialdataare the documented surface. The function stays public and is still used by the tutorial notebook andscripts/geojson_to_spatialdata.py; it just no longer gets a generated reference page.