Repository navigation
Update examples & docs (esp. API reference) pre 3.5.0 release - #121
Merged
sadielbartholomew merged 19 commits intoDec 16, 2025
Merged
sadielbartholomew merged 19 commits into
sadielbartholomew merged 19 commits into
Conversation
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.
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:
cbarlabels between variable name & units #115 fix now thatggap.ncexamples 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);and also as left-over bits from previous PRs:
validatemodule which I somehow missed committing in .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.