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

Skip to content

Cleanup of docstrings of scales #14654

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
Jul 22, 2019
Merged

Conversation

timhoffm
Copy link
Member

PR Summary

@timhoffm timhoffm added this to the v3.1.2 milestone Jun 29, 2019
@@ -100,8 +107,8 @@ def set_default_locators_and_formatters(self, axis):

def get_transform(self):
"""
The transform for linear scaling is just the
:class:`~matplotlib.transforms.IdentityTransform`.
Return the transform for linear scaling, which is just the
Copy link
Contributor

Choose a reason for hiding this comment

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

just inherit all these docstrings? not sure per-scale documentation of get_transform is really useful.

Copy link
Member Author

Choose a reason for hiding this comment

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

For now, I'd leave it. There's a bit of value to have the link to the respective transform in the subclasses. Alternatively, one could document these relations for the builtin scales in a common place. and eliminate most of the get_transforms. Almost all are just returning self._transform. But that's for another time. You are welcome to make a PR (after this is merged 😉).

@timhoffm timhoffm force-pushed the doc-scale branch 4 times, most recently from a9875dc to b653f5f Compare July 16, 2019 18:47
Copy link
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

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

Some typos to fix.

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.

one more nitpick, can self-merge after fix

@QuLogic QuLogic merged commit 72d6bed into matplotlib:master Jul 22, 2019
@lumberbot-app
Copy link

lumberbot-app bot commented Jul 22, 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.1.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 72d6bede7d92aa7f3ae6a72e19e2ed3b65f68b69
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #14654: Cleanup of docstrings of scales'
  1. Push to a named branch :
git push YOURFORK v3.1.x:auto-backport-of-pr-14654-on-v3.1.x
  1. Create a PR against branch v3.1.x, I would have named this PR:

"Backport PR #14654 on branch v3.1.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.

@timhoffm
Copy link
Member Author

Not bothering to backport as 3.2 is approaching.

@timhoffm timhoffm deleted the doc-scale branch July 22, 2019 23:16
@QuLogic QuLogic modified the milestones: v3.1.2, v3.2.0 Jul 22, 2019
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