Skip to content

Added RectangleSelector.geometry docstring#1

Merged
tropfcode merged 1 commit into
masterfrom
Rectangle-Selector-geometry-docstring
Aug 14, 2017
Merged

Added RectangleSelector.geometry docstring#1
tropfcode merged 1 commit into
masterfrom
Rectangle-Selector-geometry-docstring

Conversation

@tropfcode

@tropfcode tropfcode commented Aug 14, 2017

Copy link
Copy Markdown
Owner

Docstring contains details specific to RectangleSelector and does not fully generalize to EllipseSelector.

PR Summary

Added docstring to geometry property of RectangleSelector. EllipseSelector geometry property
returns slightly different information, so this docstring is specific to RectangleSelector.

PR Checklist

  • Has Pytest style unit tests
  • [ x] Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • [ x] Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

Docstring contains details specific to RectangleSelector and does not fully generalize to EllipseSelector.
@tropfcode tropfcode merged commit 2b83aa6 into master Aug 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant