Skip to content

docs: improve bounds_to_vertices and vertices_to_bounds docstrings - #642

Merged
dcherian merged 2 commits into
xarray-contrib:mainfrom
SAY-5:docs/numpydoc-validation-warnings
Jul 29, 2026
Merged

docs: improve bounds_to_vertices and vertices_to_bounds docstrings#642
dcherian merged 2 commits into
xarray-contrib:mainfrom
SAY-5:docs/numpydoc-validation-warnings

Conversation

@SAY-5

@SAY-5 SAY-5 commented May 19, 2026

Copy link
Copy Markdown
Contributor

Addresses the docstring numpydoc warnings in #322 for the two public helpers functions: single-line summary (SS06), a description for the return value of vertices_to_bounds (RT03), and a See Also section plus runnable Examples (SA01, EX01) for both functions. The issue notes it "would be good to clean up these warnings".

@dcherian
dcherian enabled auto-merge (squash) July 29, 2026 18:43
@dcherian
dcherian merged commit 76e2e5a into xarray-contrib:main Jul 29, 2026
11 checks passed
@codecov

codecov Bot commented Jul 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.07%. Comparing base (a9cebee) to head (4f0c556).
⚠️ Report is 125 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #642      +/-   ##
==========================================
+ Coverage   85.78%   87.07%   +1.29%     
==========================================
  Files          13       16       +3     
  Lines        2364     3320     +956     
  Branches      183      309     +126     
==========================================
+ Hits         2028     2891     +863     
- Misses        303      381      +78     
- Partials       33       48      +15     
Flag Coverage Δ
mypy 46.23% <ø> (+7.69%) ⬆️
unittests 92.57% <ø> (-1.42%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants