Skip to content

Update examples & docs (esp. API reference) pre 3.5.0 release - #121

Merged
sadielbartholomew merged 19 commits into
NCAS-CMS:mainfrom
sadielbartholomew:update-examples-selection-etc
Dec 16, 2025
Merged

sadielbartholomew merged 19 commits into
NCAS-CMS:mainfrom
sadielbartholomew:update-examples-selection-etc

Conversation

@sadielbartholomew

@sadielbartholomew sadielbartholomew commented Dec 16, 2025 •

Copy link
Copy Markdown
Member

Close #119 and #120 by updating examples with datasets which correspond to more than one Field when read-in, both in the test suite and in the docs - including adding a 'tip' admonition to explain to users that there are different ways to filter FieldLists and the consistent approach the examples take for the choice used.

More generally, update the docs also in preparedness for a v3.5.0 release in January, via:

  • updating remaining reference images for test suite for Missing space in cbar labels between variable name & units #115 fix now that ggap.nc examples fail w/ downloaded data due to indexing #120 has been fixed such that the tests generate the correct plot with the gap between name and units included (full test suite now passes again);
  • remove internal API from API reference now it is obsolete;
  • add sub-headings to categorise the functions in the API reference instead of having them all in one big list;
  • use autosummary to list functions in API reference - they were listed as standard TOC tree pages from Andy's docs, hence the weird doubled item listing.

and also as left-over bits from previous PRs:

  • add the validate module which I somehow missed committing in .
  • update the Changelog with recent updates.

A bit of a bumper PR but in the interests of time left before Christmas I've put this all in one rather than separate PRs - individual commit messages should help to classify changes relative to the above list.

@sadielbartholomew sadielbartholomew self-assigned this Dec 16, 2025
@sadielbartholomew
sadielbartholomew merged commit 022ff9a into NCAS-CMS:main Dec 16, 2025
@sadielbartholomew
sadielbartholomew deleted the update-examples-selection-etc branch December 16, 2025 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Field selection: use select_by_* methods instead of indexing

1 participant