Skip to content

Document legend's slowness when "best" location is used#12203

Merged
ImportanceOfBeingErnest merged 2 commits into
matplotlib:masterfrom
kbrose:document-legend-best-slowness
Sep 21, 2018
Merged

Document legend's slowness when "best" location is used#12203
ImportanceOfBeingErnest merged 2 commits into
matplotlib:masterfrom
kbrose:document-legend-best-slowness

Conversation

@kbrose

@kbrose kbrose commented Sep 21, 2018

Copy link
Copy Markdown
Contributor

PR Summary

Document the slowness of legend's default axis behavior with large amounts of data. Ref #12120.

PR Checklist

  • Documentation is sphinx and numpydoc compliant

p.s. Congrats on 3.0!

@kbrose

kbrose commented Sep 21, 2018

Copy link
Copy Markdown
Contributor Author

For "Documentation is sphinx and numpydoc compliant" is there a way I can verify that? Do the circle CI runs check that? Maybe there will be a build of the docs I could look at to make sure it looks correct?

@jklymak

jklymak commented Sep 21, 2018

Copy link
Copy Markdown
Member

You can check the output in the CircleCI logs for the location of the built documentation, follow that link and see that it looks OK.

@ImportanceOfBeingErnest

Copy link
Copy Markdown
Member

The documentation build of your PR is available at https://circleci.com/gh/matplotlib/matplotlib/13683/artifacts/0//home/circleci/project/doc/build/html/index.html You find this link via he "Details"-Button on the checks.

@ImportanceOfBeingErnest

ImportanceOfBeingErnest commented Sep 21, 2018

Copy link
Copy Markdown
Member

This is only a minor point, but in general the documentation mostly uses a passive style, like "A parameter can be set." instead of "You may set a parameter."
I don't think this is relevant for the tutorial, where "you" is also used at other places, but for the docstring itself?

@kbrose

kbrose commented Sep 21, 2018

Copy link
Copy Markdown
Contributor Author

Should I change to passive? I thought it may be but I did a ctrl-f "you" in https://matplotlib.org/users/legend_guide.html and found examples so I thought it'd be fine.

@jklymak

jklymak commented Sep 21, 2018

Copy link
Copy Markdown
Member

My vote is for active voice most of the time.

@ImportanceOfBeingErnest

Copy link
Copy Markdown
Member

Nevermind, even the Axes.legend docstring addressed the reader in person before this change.

@ImportanceOfBeingErnest ImportanceOfBeingErnest merged commit 098b865 into matplotlib:master Sep 21, 2018
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 21, 2018
@kbrose kbrose deleted the document-legend-best-slowness branch September 21, 2018 18:54
QuLogic added a commit that referenced this pull request Sep 21, 2018
…203-on-v3.0.x

Backport PR #12203 on branch v3.0.x (Document legend best slowness)
@kbrose kbrose changed the title Document legend best slowness Document legend's slowness when "best" location is used Sep 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants