DOC - SpanSelector widget documentation #7047
Conversation
|
|
||
| If *minspan* is not *None*, ignore events smaller than *minspan* | ||
| onmove_callback : function of form func(min, max), where min/max are floats, default is None |
There was a problem hiding this comment.
I am pretty sure this line is too long for the pep8 requirements (to be confirmed when travis finish running).
|
I am slightly confused on why the pep8 test pass here, while they don't for all of my students :( widgets.py|1710 col 80| E501 line too long (96 > 79 characters) Apart from this, and my additional comment, the patch looks good! Thanks, |
|
The changed file is listed in the known bad files list, so any PEP8 issues in it get ignored. If your students wish to correct these issues, that would be much appreciated. |
| @@ -1794,7 +1799,7 @@ def new_axes(self, ax): | |||
| self.ax.add_patch(self.rect) | |||
| self.artists = [self.rect] | |||
|
|
|||
| def ignore(self, event): | |||
| def _ignore(self, event): | |||
There was a problem hiding this comment.
I'm not sure you should be changing the name here. Surely there are other callers that should be updated as well?
There was a problem hiding this comment.
You are totally right. I thought I changed where it is called as well. I will take another look.
|
I can't seem to do a linebreak with doctest line 1732 and make it work. And I feel making that line shorter would just muddle it and look poor. It turns out there is in fact an example for SpanSelector in the examples folder, but since it is interactive, telling it to plot to the docs doesn't make much sense. Should I just make a link to the example, and if so, how would I make that link? |
|
I think the following is fine:: |
0ade4ba to
27aebe7
Compare
Add reference to AxesWidget.active for disabling the selector. Resolves matplotlib#7009
27aebe7 to
f1c72a8
Compare
|
So, Travis is giving this: Does that mean it can be removed from the list or am I missing something? |
|
It seems you have fixed all pep8 problems in |
|
The failure on travis is unrelated. LGTM 👍 |
|
Failure is unrelated. Restarted the particular travis job to be sure |
DOC: SpanSelector widget documentation
|
backported to v2.x as a2e56ad |
Initial focus was to add a reference to AxesWidget.active in the documentation. I went ahead and made it numpy standard while I was in there.
Removed: I made the
ignoremethod into_ignoreso that it would not be build into the docs, as a user will have zero reason to call it.Resolves #7009