PEP8 fixes to colorbar.py #1336
Conversation
| *False*. To manually update the ticks, call *update_ticks* method explicitly. | ||
| set tick locations. Tick locations are updated immediately unless | ||
| update_ticks is *False*. To manually update the ticks, call | ||
| *update_ticks* method explicitly. |
There was a problem hiding this comment.
This docstring needs a little massaging to work better with sphinx. I may be wrong, but I think update_ticks (the kwarg) needs to be encased in asterisks. And when referring to the update_ticks (the method), one usually uses meth:update_ticks. I'm mot entirely on the syntax of that, though.
Edit: clarity
There was a problem hiding this comment.
This is "early" Sphinx syntax that we've adopted (as we were an early adopter, of course), so it's a bit different from what Numpy does, for example. (Hopefully we'll have a chance to go through and improve the consistency of docstrings at some point). Asterisks for kwargs, backticks for cross references to methods, functions, classes, etc.
There was a problem hiding this comment.
Should I modify this to "numpy" syntax or leave it as it is? The only modification I've done here is set the 79 caracter limit.
There was a problem hiding this comment.
Keep this pull request just for PEP8 compliancy. As @mdboom points out, we should not only implement the changes for this docstring, but for all the other docstring inconsistencies as well.
|
Aside from the minor docstring gripes -- which are not PEP8 compliancy issues, but sphinx compliancy issues -- this gets my +1. |
|
Aside from the comments already here, +1. |
Pep8 fixes on the module colorbar.
Thanks,
N