Skip to content

Added RectangleSelector.geometry docstring #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2017

Conversation

tropfcode
Copy link
Owner

@tropfcode tropfcode commented Aug 14, 2017

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