Update to loading docs to cover absence of 'or' for constraints#4321
Merged
stephenworsley merged 6 commits intoSciTools:mainfrom Sep 20, 2021
Merged
Conversation
Member
|
Nice addition @wjbenfold. This should probably close #4091 as not going to be implemented. |
pp-mo
reviewed
Sep 16, 2021
Member
stephenworsley
requested changes
Sep 16, 2021
Contributor
stephenworsley
left a comment
stephenworsley
left a comment
There was a problem hiding this comment.
Looks good, just a couple suggestions.
pp-mo
reviewed
Sep 17, 2021
stephenworsley
requested changes
Sep 17, 2021
Contributor
stephenworsley
left a comment
stephenworsley
left a comment
There was a problem hiding this comment.
Looks good, just a tiny comment and I think this is good to go.
added 6 commits
September 20, 2021 11:48
wjbenfold
force-pushed
the
wjbenfold_load_docs_constraint_or
branch
from
7293dc5 to
6ab437a
Compare
Contributor
Author
|
Rebased onto main |
stephenworsley
approved these changes
Sep 20, 2021
Contributor
stephenworsley
left a comment
stephenworsley
left a comment
There was a problem hiding this comment.
Looks good to me.
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Sep 22, 2021
* main: (94 commits) added support for make html-noapi and html-quick for the docs build (SciTools#4333) Refactor some netcdf save code (SciTools#4301) [pre-commit.ci] pre-commit autoupdate (SciTools#4329) Update to loading docs to cover absence of 'or' for constraints (SciTools#4321) update latest.rst.template (SciTools#4323) stable cartopy feature download (SciTools#4328) Skip TestConstrainedLoad if data missing (SciTools#4319) Add 'Good First Issue' label to reasons an issue doesn't go stale (SciTools#4317) Gallery: simplify quiver example (SciTools#4120) Improve styling in a minor way in docs (SciTools#4314) bump version (SciTools#4310) Made clear we only test on Linux. (SciTools#4309) Updated environment lockfiles (SciTools#4308) Include Discussions in Getting Involved. (SciTools#4307) Fixed text to show as link. (SciTools#4305) [pre-commit.ci] pre-commit autoupdate (SciTools#4299) Updated environment lockfiles (SciTools#4298) cartopy feature download (SciTools#4304) Mesh Loading (AVD-1813) (SciTools#4262) reset whatsnew latest (SciTools#4288) ...
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
5 participants
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.
🚀 Pull Request
Description
Added documentation to Iris Constrained Loading docs to highlight that Constraints don't support ¦ (and explain why)
Whilst addressing a recent support request it seemed that there should be an ability to logically "or" Constraints as well as to "and" them. The reasons for this weren't immediately obvious, so documenting it seems useful for the future. I've done so.
I'd note, I'm not 100% convinced that this is an improvement to the quality of the docs, as I can see the argument that in catering for an edge case of misunderstanding the docs may become less easily understood by those without this misunderstanding (particularly as loading is likely to be one of the first bits of documentation a new user reads). Happy to discuss the merits of this and/or axe this PR on that basis.
Consult Iris pull request check list