-
Notifications
You must be signed in to change notification settings - Fork 283
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhance Cube slicing docs #5735
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5735 +/- ##
=======================================
Coverage 89.76% 89.77%
=======================================
Files 93 93
Lines 22982 22995 +13
Branches 5006 5011 +5
=======================================
+ Hits 20630 20643 +13
Misses 1622 1622
Partials 730 730 ☔ View full report in Codecov by Sentry. |
Adding `# doctest: SKIP` statements to multiline prints
for more information, see https://pre-commit.ci
Add ruff linting exceptions to avoid getting stuck in a failing test loop
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
N.B. I've aimed for judicious use of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @hsteptoe, and sorry for the delay.
This is a really valuable addition for an area that I personally regularly forget - examples are gold!
I felt it was important to get the doctests working, to make sure the code continues working in perpetuity. I was able to test and iterate the formatting locally using this handy command (run within an Iris development environment, within the /docs/src
directory):
sphinx-build -b doctest -d _build/doctrees . _build/doctest generated/api/iris.cube.rst
The suggestions work, and pass the pre-commit checks.
Brilliant, thanks again! |
* upstream/main: Enhance Cube slicing docs (SciTools#5735) Bump scitools/workflows from 2024.04.0 to 2024.04.1 (SciTools#5914) [pre-commit.ci] pre-commit autoupdate (SciTools#5913) Revert "Updated environment lockfiles (SciTools#5911)" (SciTools#5912) Shapefile user guide typos (SciTools#5759) Updated environment lockfiles (SciTools#5911)
🚀 Pull Request
Description
Some relatively minor enhancements to the docs for the
cube.slices()
andcube.slices_over()
.iris-sample-data
Consult Iris pull request check list