Added RectangleSelector.geometry docstring #9031
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
Docstring contains details specific to RectangleSelector and does not fully generalize to EllipseSelector.
dstansby
requested changes
Aug 16, 2017
lib/matplotlib/widgets.py
Outdated
| @@ -2334,6 +2334,11 @@ def _set_active_handle(self, event): | |||
|
|
|||
| @property | |||
| def geometry(self): | |||
| """ | |||
| Returns numpy.ndarray of shape (2,5) containing x (RectangleSelector.geometry[1:]) | |||
There was a problem hiding this comment.
All of the lines need to be wrapped to < 80 characters for PEP8 tests to pass.
Wrapped docstring to <80 characters
dstansby
reviewed
Aug 18, 2017
lib/matplotlib/widgets.py
Outdated
| @@ -2334,6 +2334,12 @@ def _set_active_handle(self, event): | |||
|
|
|||
| @property | |||
| def geometry(self): | |||
| """ | |||
There was a problem hiding this comment.
Sorry I missed this before, but the whole string will need to be indented by 4 spaces (instead of the current 2) to line up with the if statement below.
|
Looks like it's still failing on PEP8 checks - the easiest way to check this in advance is using a text editor like Atom which has a PEP8 linter. The specific error is that there's whitespace at the end of some of the lines, so removing the whitespace should remove the error. |
dstansby
approved these changes
Sep 21, 2017
|
@meeseeksdev backport to v2.1.x |
|
@meeseeksdev backport to v2.1.x |
lumberbot-app bot
pushed a commit
that referenced
this pull request
Sep 21, 2017
Docstring contains details specific to RectangleSelector and does not fully generalize to EllipseSelector. <!--Thank you so much for your PR! To help us review, fill out the form to the best of your ability. Please make use of the development guide at https://matplotlib.org/devdocs/devel/index.html--> <!--Provide a general summary of your changes in the title above, for example "Raises ValueError on Non-Numeric Input to set_xlim". Please avoid non-descriptive titles such as "Addresses issue 8576".--> <!--If you are able to do so, please do not create the PR out of master, but out of a separate branch. See https://matplotlib.org/devel/gitwash/development_workflow.html for instructions.--> PR Summary <!--Please provide at least 1-2 sentences describing the pull request in detail. Why is this change required? What problem does it solve?--> Matplotlib documentation is missing details concerning the geometry attribute for RectangleSelector. This change provides a docstring for said attribute which is specific to RectangleSelector and not generalizable to EllipseSelector. <!--If it fixes an open issue, please link to the issue here.--> PR Checklist - [ x] Has Pytest style unit tests - [ x] Code is PEP 8 compliant - [ x] New features are documented, with examples if plot related - [ x] Documentation is sphinx and numpydoc compliant - [ x] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there) - [x ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way <!--We understand that PRs can sometimes be overwhelming, especially as the reviews start coming in. Please let us know if the reviews are unclear or the recommended next step seems overly demanding , or if you would like help in addressing a reviewer's comments. And please ping us if you've been waiting too long to hear back on your PR.-->
tacaswell
added a commit
that referenced
this pull request
Sep 22, 2017
Backport PR #9031 on branch v2.1.x
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.
Docstring contains details specific to RectangleSelector and does not fully generalize to EllipseSelector.
PR Summary
Matplotlib documentation is missing details concerning the geometry attribute for RectangleSelector.
This change provides a docstring for said attribute which is specific to RectangleSelector and
not generalizable to EllipseSelector.
PR Checklist