Update isku.extract_regions docs#73
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #73 +/- ##
=======================================
Coverage 98.11% 98.11%
=======================================
Files 3 3
Lines 53 53
=======================================
Hits 52 52
Misses 1 1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kemccusker
reviewed
Jul 8, 2026
kemccusker
left a comment
Member
There was a problem hiding this comment.
Thanks, @brews, this is a helpful update
Member
Author
|
Thank you very much for taking a look, @kemccusker . |
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.
User mentioned they wanted to extract regions without transformations. Based on their feedback, this PR is a quick update to docstrs so it's a bit easier for users to discover.
Basically, users can directly use
isku.GridWeightingRegions.extract_regions()if they don't need pre and post processing transformations ofisku.extract_regions().Also updates zensical config so that function parameters don't appear in the API Reference docs table of contents.