Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Really fix ArtistInspector.get_aliases #13432

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

Conversation

ImportanceOfBeingErnest
Copy link
Member

@ImportanceOfBeingErnest ImportanceOfBeingErnest commented Feb 14, 2019

PR Summary

Fixes #13278.

Either #9475 or #12037 broke ArtistInspector.get_aliases which would contrarily to the docstring produce a dictionary of the form

'get_linestyle': {'ls'}, 'get_linewidth': {'lw'},

instead of

 'linestyle': {'ls'}, 'linewidth': {'lw'},

This is detrimental to the documentation of the aliases, which would hence not appear in the docs any more.

Previsouly

image

With this PR

image

Adds a test as well, not to break it again.

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

@ImportanceOfBeingErnest ImportanceOfBeingErnest added this to the v3.0.3 milestone Feb 14, 2019
Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

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

oops, thanks for the catch.

@jklymak jklymak merged commit 46a704e into matplotlib:master Feb 14, 2019
@lumberbot-app
Copy link

lumberbot-app bot commented Feb 14, 2019

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 46a704e22079527f9c47dc43dc7b77d2e4688a6f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #13432: Really fix ArtistInspector.get_aliases'
  1. Push to a named branch :
git push YOURFORK v3.0.x:auto-backport-of-pr-13432-on-v3.0.x
  1. Create a PR against branch v3.0.x, I would have named this PR:

"Backport PR #13432 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.

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.

Doc: Alias names disappeared from documentation
4 participants