Repository navigation
DOC: Unpin numpydoc, add nitpick exception rules - #10530
Conversation
pllim
changed the title
This comment has been minimized.
This comment has been minimized.
|
|
||
| get_cdelt = """ | ||
| get_cdelt() -> ``double array[naxis]`` | ||
| get_cdelt() -> numpy.ndarray |
There was a problem hiding this comment.
Note: Apparently linking was still attempted despite the double-backticks. This is some C-extension thingy, so I am not going to question it... 🤷
|
RTD passed without numpydoc pinning! I'll let the full CI run too, just in case. UPDATE: CI passed. |
mhvk
left a comment
mhvk
left a comment
There was a problem hiding this comment.
This is great! And sorry to see that list of tuple doesn't work... One suggestion: let's keep the exceptions together in one file...
| nitpicky = True | ||
| nitpick_ignore = [] | ||
| # This list is from https://github.com/numpy/numpydoc/issues/275 | ||
| nitpick_ignore = [ |
There was a problem hiding this comment.
I think we should add them to nitpick_exceptions; I found it needs to be without the quotes:
# sphinx doing strange things with dict methods
py:class None. Remove all items from D.
py:class a set-like object providing a view on D's items
py:class a set-like object providing a view on D's keys
py:class v, remove specified key and return the corresponding value.
py:class None. Update D from dict/iterable E and F.
py:class an object providing a view on D's values
py:class a shallow copy of D
|
Thanks! Is there a reason the nitpick exceptions can’t live in the dedicated file? |
No. I wasn't even aware the is a dedicated file. Personally, I like all the settings in one place but I'll move it as requested. |
DOC: Unpin numpydoc, add nitpick exception rules
|
I am backporting this to v4.1.x to fix some docs failures there |
DOC: Unpin numpydoc, add nitpick exception rules
4 participants
Follow up of #10524 . Fix #10529. Thanks to numpy/numpydoc#275 (comment) .