Skip to content

Improve docstring of Annotation#12214

Merged
ImportanceOfBeingErnest merged 1 commit intomatplotlib:masterfrom
timhoffm:doc-annotate
Sep 30, 2018
Merged

Improve docstring of Annotation#12214
ImportanceOfBeingErnest merged 1 commit intomatplotlib:masterfrom
timhoffm:doc-annotate

Conversation

@timhoffm
Copy link
Copy Markdown
Member

@timhoffm timhoffm commented Sep 22, 2018

PR Summary

As part of #10148: Docstring update for Annotation.

@timhoffm timhoffm added this to the v3.0.x milestone Sep 22, 2018
ImportanceOfBeingErnest
ImportanceOfBeingErnest reviewed Sep 22, 2018
View reviewed changes
Comment thread lib/matplotlib/text.py Outdated
ImportanceOfBeingErnest
ImportanceOfBeingErnest reviewed Sep 22, 2018
View reviewed changes
Comment thread lib/matplotlib/text.py Outdated
`~matplotlib.backend_bases.RendererBase` object as input
and return a `~matplotlib.transforms.Transform` or
`~matplotlib.transforms.Bbox` object
where *render* is a `.RendererBase` subclass.
Copy link
Copy Markdown
Member

@ImportanceOfBeingErnest ImportanceOfBeingErnest Sep 22, 2018

Choose a reason for hiding this comment

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

renderer

ImportanceOfBeingErnest
ImportanceOfBeingErnest reviewed Sep 22, 2018
View reviewed changes
Comment thread lib/matplotlib/text.py Outdated
@ImportanceOfBeingErnest
Copy link
Copy Markdown
Member

ImportanceOfBeingErnest commented Sep 22, 2018

Annotation has properties anncoords and xyann which do not have any docstring. Not sure if this shall be part of this PR, but it would be good to document those.

@timhoffm timhoffm force-pushed the doc-annotate branch 2 times, most recently from 97f91ff to 66d787e Compare September 23, 2018 08:49
@timhoffm
Copy link
Copy Markdown
Member Author

timhoffm commented Sep 23, 2018

I've added docstrings for anncoords and xyann. It's unfortunate that they have a different name than the corresponding constructor parameters. But that would be something for another PR.

@timhoffm timhoffm mentioned this pull request Sep 23, 2018
Merged
@anntzer
Copy link
Copy Markdown
Contributor

anntzer commented Sep 23, 2018

See also #12144 re: mismatched names in constructor.

@ImportanceOfBeingErnest
Copy link
Copy Markdown
Member

ImportanceOfBeingErnest commented Sep 24, 2018

I've added docstrings for anncoords and xyann.

I don't see any change to the previous version.
image

@timhoffm timhoffm force-pushed the doc-annotate branch 3 times, most recently from 25ca6ee to 8bb39f5 Compare September 24, 2018 18:46
ImportanceOfBeingErnest
ImportanceOfBeingErnest approved these changes Sep 30, 2018
View reviewed changes
Copy link
Copy Markdown
Member

@ImportanceOfBeingErnest ImportanceOfBeingErnest left a comment

Choose a reason for hiding this comment

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

All comments handled.

@ImportanceOfBeingErnest ImportanceOfBeingErnest merged commit 7bcf618 into matplotlib:master Sep 30, 2018
@lumberbot-app
Copy link
Copy Markdown

lumberbot-app Bot commented Sep 30, 2018

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v3.0.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 7bcf6186e9420608ab60ea36b76f9a295aa4ea8a
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #12214: Improve docstring of Annoation'
  1. Push to a named branch :
git push YOURFORK v3.0.x:auto-backport-of-pr-12214-on-v3.0.x
  1. Create a PR against branch v3.0.x, I would have named this PR:

"Backport PR #12214 on branch v3.0.x"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

ImportanceOfBeingErnest added a commit to ImportanceOfBeingErnest/matplotlib that referenced this pull request Sep 30, 2018
@ImportanceOfBeingErnest
Merge pull request matplotlib#12214 from timhoffm/doc-annotate
ed460c8 
Improve docstring of Annoation
@ImportanceOfBeingErnest ImportanceOfBeingErnest mentioned this pull request Sep 30, 2018
Merged
6 tasks
@ImportanceOfBeingErnest
Copy link
Copy Markdown
Member

ImportanceOfBeingErnest commented Sep 30, 2018

This was tagged with v3.0.x. So when merging, it tried to autobackport to that branch. I resolved the conflict (which was a single empty line (??)), and created #12214, but does this now still need to go to v3.0.0-doc? Should it have been tagged with v3.0.0-doc instead?

@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Sep 30, 2018

Changes in .py files do not belong on the -doc branches as they have no effect on the resulting doc rebuilds.

@timhoffm timhoffm deleted the doc-annotate branch October 1, 2018 05:52
dstansby added a commit that referenced this pull request Oct 1, 2018
@dstansby
Merge pull request #12350 from ImportanceOfBeingErnest/auto-backport-…
316e173 
…of-pr-12214-on-v3.0.x

Backport PR #12214 on branch v3.0.x
@QuLogic QuLogic changed the title Improve docstring of Annoation Improve docstring of Annotation Apr 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ImportanceOfBeingErnest ImportanceOfBeingErnest ImportanceOfBeingErnest approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v3.0.1

Development

Successfully merging this pull request may close these issues.

5 participants

@timhoffm @ImportanceOfBeingErnest @anntzer @QuLogic @tacaswell