Skip to content

Add explanatory comment to annotation box example #13163

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 15, 2019
Merged

Add explanatory comment to annotation box example #13163

merged 1 commit into from
Jan 15, 2019

Conversation

mollyrossow
Copy link
Contributor

PR Summary

This pull request adds explanatory text to the Demo Annotation Box gallery example in response to issue #11654.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • 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

jklymak
jklymak reviewed Jan 11, 2019
View reviewed changes
Copy link
Member

@jklymak jklymak left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Can you also add a References section like in simple_plot.py? That will put links to this example in the docs for AnnotationBox

  • Code didn't pass flake8 😉

Thanks a lot for the PR!

examples/text_labels_and_annotations/demo_annotation_box.py Outdated
@@ -3,7 +3,12 @@
Demo Annotation Box
===================

The AnnotationBbox Artist creates an annotation on some location using an
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest strike: "on some location". Vague and doesn't help the sentence....

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

examples/text_labels_and_annotations/demo_annotation_box.py Outdated
The AnnotationBbox Artist creates an annotation on some location using an
OffsetBox. This example demonstrates three different OffsetBoxes: TextArea,
DrawingArea and OffsetImage. AnnotationBbox gives more fine-grained control
than using the axes method annotate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we link as .axes.Axes.annotate?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link added.

@jklymak jklymak added this to the v3.1 milestone Jan 11, 2019
@mollyrossow mollyrossow force-pushed the explain_annotation_example branch from 1b303a1 to c4bfd15 Compare January 15, 2019 17:51
@jklymak
Copy link
Member

jklymak commented Jan 15, 2019

Thanks a lot @mollyrossow !

@jklymak jklymak merged commit 64eef6e into matplotlib:master Jan 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak left review comments

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.1.0
Development

Successfully merging this pull request may close these issues.
3 participants
@mollyrossow @jklymak @QuLogic