Skip to content

Update isku.extract_regions docs#73

Merged
brews merged 3 commits into
ClimateImpactLab:mainfrom
brews:update_extraction_docs
Jul 8, 2026
Merged

Update isku.extract_regions docs#73
brews merged 3 commits into
ClimateImpactLab:mainfrom
brews:update_extraction_docs

Conversation

@brews

@brews brews commented Jul 7, 2026

Copy link
Copy Markdown
Member

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 of isku.extract_regions().

Also updates zensical config so that function parameters don't appear in the API Reference docs table of contents.

@brews brews self-assigned this Jul 7, 2026
@brews brews added the documentation Improvements or additions to documentation label Jul 7, 2026
@codecov-commenter

codecov-commenter commented Jul 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.11%. Comparing base (e5cc904) to head (c11d60c).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@brews brews marked this pull request as ready for review July 7, 2026 12:04

@kemccusker kemccusker left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @brews, this is a helpful update

@brews

brews commented Jul 8, 2026

Copy link
Copy Markdown
Member Author

Thank you very much for taking a look, @kemccusker .

@brews brews added the enhancement New feature or request label Jul 8, 2026
@brews brews merged commit 70a3e7c into ClimateImpactLab:main Jul 8, 2026
5 checks passed
@brews brews deleted the update_extraction_docs branch July 8, 2026 23:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants