-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
_preprocess_data interferes in the docstrings Notes section #7095
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Which note? If it's |
No, it is the numpydoc section "Notes". You can see the effect it has by comparing the rendered version of scatter: http://matplotlib.org/api/pyplot_api.html#matplotlib.pyplot.scatter Note that the the docstring.Appender also doesn't work as it should in the rendering. Because of all this is very none standard, it makes it hard to identify where the problem comes from. |
I have opened a bug on numpydoc for this issue (it should not have been undetected for so long): |
This is actually critical to having a reasonably polished 2.0. One way to fix it might be to use string interpolation instead of appending the "data" doc block. This would have the advantage of providing full control over where that paragraph goes. It's not clear to me it really belongs in the Notes section anyway. |
I can fix this by manually updating the different docstrings of that section to reflect the categorical input and remove the automatic appending of the notes section. |
One step closer to 2.0… |
_preprocess_data interferes with the docstrings Notes section. It appends a Notes section (1) in the wrong section; (2) in the rendering, it overwrites the notes section of the function.
In general, I think matplotlib is trying to be way too smart in appending/replacing stuff in the docstrings. It makes contributing to the documentation (and matplotlib in general) quite hard and often interferes with sphinx or other tools we use. We should try to be more standard.
The text was updated successfully, but these errors were encountered: