Skip to content

add mesh public doc-strings#4037

Merged
trexfeathers merged 4 commits intoSciTools:mesh-data-modelfrom
bjlittle:mesh-doc-strings
Mar 1, 2021
Merged

add mesh public doc-strings#4037
trexfeathers merged 4 commits intoSciTools:mesh-data-modelfrom
bjlittle:mesh-doc-strings

Conversation

@bjlittle
Copy link
Member

@bjlittle bjlittle commented Feb 26, 2021

🚀 Pull Request

Description

This PR adds the doc-strings to the public API methods of the class iris.experimental.ugrid.Mesh et al.

To view the rendered doc-strings for this pull-request, see here.


Consult Iris pull request check list

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😊

@trexfeathers
Copy link
Contributor

Amazing work as usual @bjlittle, LGTM

@trexfeathers trexfeathers merged commit c34662c into SciTools:mesh-data-model Mar 1, 2021
@bjlittle
Copy link
Member Author

bjlittle commented Mar 1, 2021

@trexfeathers Hallelujah 💯 🚀 🥳

Thanks for sticking with it 🍻

@bjlittle bjlittle deleted the mesh-doc-strings branch March 2, 2021 13:54
@trexfeathers trexfeathers mentioned this pull request Aug 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants