Automatic API Documentation #155
Conversation
Codecov Report
@@ Coverage Diff @@
## main #155 +/- ##
=======================================
Coverage 99.56% 99.56%
=======================================
Files 27 27
Lines 2073 2073
=======================================
Hits 2064 2064
Misses 9 9
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Looks good as far as improving the docstrings go. I just have the one comment regarding what was already a typo. I think there are probably cases where I'd want to rethink some of the docstrings as part of a larger overhaul, but I'd say that should be considered outside the scope of this PR.
There was a problem hiding this comment.
@trexfeathers Awesome LGTM.
Just a minor question to service, but let's get this banked 💯 👨🎤
| docs = | ||
| pydata-sphinx-theme | ||
| sphinx | ||
| sphinx-copybutton |
There was a problem hiding this comment.
No sphinxcontrib-apidoc here ?
| this cube will be converted to values on the new grid using | ||
| :class:`iris.cube.Cube` | ||
| A :class:`~iris.cube.Cube` defined with the horizontal dimensions of the target | ||
| and the other dimensions from this :class:`~iris.cube.Cube`. The |
There was a problem hiding this comment.
I think this should refer to the argument "cube" rather than the class "Cube".
| this cube will be converted to values on the new grid using | ||
| :class:`iris.cube.Cube` | ||
| A :class:`~iris.cube.Cube` defined with the horizontal dimensions of the target | ||
| and the other dimensions from this :class:`~iris.cube.Cube`. The |
There was a problem hiding this comment.
I think this should refer to the argument "cube" rather than the class "Cube".
Here is a rendered example on Read the Docs