add mesh public doc-strings#4037
Conversation
trexfeathers
left a comment
There was a problem hiding this comment.
Thanks @bjlittle!
These docstrings are clear, informative and appropriately mirror phrasing in the UGRID conventions.
I've picked up on some corrections that are needed.
As mentioned in specific comments on the code, I have trouble with the level of repetition between the filter methods, their singular equivalents and the remove methods. As I read/scroll through the rendered docs this repetition makes it much harder to keep my place. I like the pattern currently used for documenting Cube.coord() as a solution.
b5b574e to
e53d7db
Compare
trexfeathers
left a comment
There was a problem hiding this comment.
Thanks for the latest clarifications @bjlittle. Here are some final requests in light of my improved understanding. Once these are addressed I'll be delighted to merge 😊
|
Amazing work as usual @bjlittle, LGTM |
|
@trexfeathers Hallelujah 💯 🚀 🥳 Thanks for sticking with it 🍻 |
🚀 Pull Request
Description
This PR adds the doc-strings to the public API methods of the class
iris.experimental.ugrid.Meshet al.To view the rendered doc-strings for this pull-request, see here.
Consult Iris pull request check list