Write all ACCEPTS markers in docstrings as comments. #15074
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
commented
Aug 17, 2019
| clipping box to the corresponding rectangle and set the clipping path | ||
| to ``None``. | ||
|
|
||
| For technical reasons (support of ``setp``), a tuple |
There was a problem hiding this comment.
I assume that's the reason. Don't know about the actual history.
There was a problem hiding this comment.
Seems true, given the note on set_boxstyle.
There was a problem hiding this comment.
I would skip the discouragement here, unless you want to put the same in set_xlim and friends...
timhoffm
commented
Aug 17, 2019
QuLogic
reviewed
Aug 18, 2019
| clipping box to the corresponding rectangle and set the clipping path | ||
| to ``None``. | ||
|
|
||
| For technical reasons (support of ``setp``), a tuple |
There was a problem hiding this comment.
Seems true, given the note on set_boxstyle.
anntzer
previously requested changes
Aug 18, 2019
There was a problem hiding this comment.
Unless I am mistaken (in which case please dismiss this), this doesn't work: previously one had
In [1]: plt.setp(plt.gca(), 'xlim')
xlim: (left: float, right: float)
but now
In [2]: plt.setp(plt.gca(), 'xlim')
xlim: float, optional
which is wrong
(this also shows up in the big properties table appended to the Axes docstring).
8caca1c to
4df7647
Compare
|
@anntzer Thanks, you are right. I've re-targeted the PR; see the first comment above. |
4df7647 to
366805d
Compare
anntzer
approved these changes
Aug 19, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
They are not needed anymore because he information can nowadays be read from numpydoc-style docstrings.This PR does not remove the parser logic nor the tests of the ACCEPTS mechanism (may be done separately).Need for accepts (current state)
As @anntzer pointed out #15074 (review) the info from ACCEPTS is still needed in some cases.
In particular, we need ACCEPTS if more than one parameter needs to be set for a property. The current implementation for it goes like this:
set_foo((a, b, c))is equivalent toset_foo(a, b, c)andsetp('foo', (a, b, c))works... ACCEPTS: (a, b, c)in the docstring. This allowssetpto provide a proper parameter description and also shows up in property lists.Docstring cleanup in this PR
This PR moves plain
ACCEPTSto comments.. ACCEPTS. Thus, these lines do not show up in the rendered HTML docs. This is preferable as the plain ACCEPTS statements are more confusing than helpful for a regular reader of the docs.Additionally, some docstrings have been improved.
Possible future improvements
Handling the tuple unpacking and parameter assignment inside the function is quite cumbersome and mixes concerns. I'm considering to move this to a decorator. The decorator could also take the data information so that the docstring can be cleaned from this
.. ACCEPTScruft. But that's for another PR (this one could still go in 3.2.0, the decorator stuff would be for 3.3).