Add edit via github method to Iris docs#4461
Merged
bjlittle merged 8 commits intoSciTools:mainfrom Jan 6, 2022
Merged
Conversation
wjbenfold
force-pushed
the
wjbenfold-doc-edit-how-to
branch
from
31ee315 to
75b40d5
Compare
Member
|
@wjbenfold Sadly this has gone slightly stale... fancy rebasing to resolve your conflict? |
wjbenfold
force-pushed
the
wjbenfold-doc-edit-how-to
branch
from
a488e4c to
feb89e9
Compare
bjlittle
requested changes
Jan 5, 2022
Member
There was a problem hiding this comment.
@wjbenfold This is a step change in clarity. Congrats! 🥳
Communicating clearly and succinctly is not easy, so I really appreciate the effort that you've put into this @wjbenfold and @alastair-gemmell
Just a few minor review suggestions to address and then we can bank this documentation goodness 👍
added 2 commits
January 5, 2022 17:38
wjbenfold
commented
Jan 6, 2022
bjlittle
reviewed
Jan 6, 2022
bjlittle
approved these changes
Jan 6, 2022
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Jan 6, 2022
* main: Use partial to make cube pickleable (SciTools#4377) Add edit via github method to Iris docs (SciTools#4461) Broken cartopy links in docs (SciTools#4464) rtd with latest mambaforge image for faster building (SciTools#4476) Show acceptable image test results in the docs (SciTools#4392) Nc load latlon fix (SciTools#4470) update matplotlib links (SciTools#4474) Whatsnew for PR 4462 (SciTools#4475) Clarify the return type of iris.load (AVD-1899) (SciTools#4462) [pre-commit.ci] pre-commit autoupdate (SciTools#4472) Updated environment lockfiles (SciTools#4467)
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
3 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
Split the "contributing documentation" page to give two options - the previous method that relies on developer knowledge and the method that uses Github's editing abilities. Added directions to the previous landing page that point people to the right one.
Consult Iris pull request check list