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

Skip to content

Improve docs on Axes limits and direction #12705

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
Nov 2, 2018

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Nov 1, 2018

PR Summary

Improve docs on Axes limits and direction. This is part of the overall Axes documentation review #10148.

Only docstring changes.

@timhoffm timhoffm added this to the v3.0.0-doc milestone Nov 1, 2018
a list of (x, y) tuples or a Nx2 array.

updatex, updatey : bool
Whether to update the x/y limits.

Choose a reason for hiding this comment

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

Adding optional, default *True* here?

I wonder what happens if you let both be False though.

Copy link
Member Author

Choose a reason for hiding this comment

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

If both are False, the BBox is invaidate()d, but the limits are not changed.


If no data is set currently, the BBox will ignore its limits and set
the bound to be the bounds of the xydata (*xys*). Otherwise, it will
compute the bounds of it's current data and the data in *xys*.

Choose a reason for hiding this comment

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

its, instead of it's

Or maybe

compute the bounds of the union of its current data and the data in xys.

Copy link
Member

@NelleV NelleV left a comment

Choose a reason for hiding this comment

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

Thanks!

@NelleV NelleV merged commit 1f0ed58 into matplotlib:master Nov 2, 2018
@lumberbot-app
Copy link

lumberbot-app bot commented Nov 2, 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 1f0ed58c6c1a026879243911e236afe4d744f95f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #12705: Improve docs on Axes limits and direction'
  1. Push to a named branch :
git push YOURFORK v3.0.x:auto-backport-of-pr-12705-on-v3.0.x
  1. Create a PR against branch v3.0.x, I would have named this PR:

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

@lumberbot-app
Copy link

lumberbot-app bot commented Nov 2, 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.0-doc
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 1f0ed58c6c1a026879243911e236afe4d744f95f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #12705: Improve docs on Axes limits and direction'
  1. Push to a named branch :
git push YOURFORK v3.0.0-doc:auto-backport-of-pr-12705-on-v3.0.0-doc
  1. Create a PR against branch v3.0.0-doc, I would have named this PR:

"Backport PR #12705 on branch v3.0.0-doc"

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 timhoffm deleted the doc-axes branch November 2, 2018 19:07
timhoffm pushed a commit to timhoffm/matplotlib that referenced this pull request Nov 2, 2018
Improve docs on Axes limits and direction
timhoffm pushed a commit to timhoffm/matplotlib that referenced this pull request Nov 2, 2018
Improve docs on Axes limits and direction
dstansby added a commit that referenced this pull request Nov 3, 2018
@tacaswell tacaswell modified the milestones: v3.0.0-doc, v3.0.x Nov 3, 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.

4 participants