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

Skip to content

3.2.0 API changes page #15163

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 5 commits into from
Sep 4, 2019

Conversation

ImportanceOfBeingErnest
Copy link
Member

PR Summary

New version of the 3.2.0 API changes page. This was started by @dstansby in #15141. Here, the remaining API changes are incorporated.

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.2.0 milestone Aug 31, 2019
@ImportanceOfBeingErnest ImportanceOfBeingErnest added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Aug 31, 2019
@ImportanceOfBeingErnest
Copy link
Member Author

I'm not 100% confident this is complete. E.g. in #11387 a file doc/api/next_api_changes/2018-10-04-AL-deprecations.rst came in, but it's not in current master.

@tacaswell
Copy link
Member

Good catch on that! I am almost afraid to ask how you noticed that, see #11387 (comment) for what I think is going on here.

I think we should bump the warning to v3.2 in the code and duplicate the deprecation text in the 3.2 API changes, but not worry about removing it from the 3.1 docs

@ImportanceOfBeingErnest
Copy link
Member Author

I now did duplicate the deprecation text in the 3.2 API changes. I did not touch source code here.

There is another "conflict" for api/api_changes/2019-02-11-PGE.rst from https://github.com/matplotlib/matplotlib/pull/13986/files. That's a change to an entry that initially into 3.1, but the change did not get backported. I think this change is anyways rather a "what's new" (now more things are supported), so we could mention it in the what's new of 3.2 instead.

@dstansby
Copy link
Member

dstansby commented Sep 2, 2019

Thanks for picking this up!

Copy link
Contributor

@afvincent afvincent left a comment

Choose a reason for hiding this comment

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

A few typos and comments (if it helps).


Reduced default value of :rc:`axes.formatter.limits`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Copy link
Contributor

Choose a reason for hiding this comment

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

Most of the titles do not have that extra line: is there a reason that it was kept here?

Copy link
Member

Choose a reason for hiding this comment

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

I didn't fix this, as we do not have a rule about that and it is done inconsistently in our documentation. If we are to establish a rule, it should be done in such a manner that everyone is aware.


Autoscaling
~~~~~~~~~~~

Copy link
Contributor

Choose a reason for hiding this comment

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

As above: most of the titles do not have that extra line.


- if the streamplot goes all the way to the edges of the vector field, then the
axis limits are set to match exactly the vector field limits (whereas they
would be sometimes be off by a small floating point error previously).
Copy link
Contributor

Choose a reason for hiding this comment

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

One extra “be” occurrence to remove in “… they
would be sometimes be off by…?”

Copy link
Member

Choose a reason for hiding this comment

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

Fixed.

would be sometimes be off by a small floating point error previously).
- if the streamplot does not reach the edges of the vector field (e.g., due to
the use of ``start_points`` and ``maxlength``), then margins expansion will
not cross the the vector field limits anymore.
Copy link
Contributor

Choose a reason for hiding this comment

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

“… the the vector field…”

Copy link
Member

Choose a reason for hiding this comment

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

Fixed

the use of ``start_points`` and ``maxlength``), then margins expansion will
not cross the the vector field limits anymore.

This change is also used internally to ensure that polar plots don't display
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess that some purists might argue for replacing “don't” with “do not”.

Copy link
Member

Choose a reason for hiding this comment

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

Didn't fix this. I don't think it matters much.


To always get the anti-aliasing behavior, no matter what the up/down sample
rate, set :rc:`interpolation` to "hanning" (or one of the other filters
available.
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing a closing parenthesis: “… one of the other filters available*)*.”

Copy link
Member

Choose a reason for hiding this comment

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

Fixed.

`~matplotlib.axes.Axes.axis()` is deprecated (such arguments used to be
silently ignored).

``minor`` argument will be become keyword-only
Copy link
Contributor

Choose a reason for hiding this comment

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

The title phrasing sounds a bit weird (at least to my non-native ears…): “… will be become…?”

Copy link
Member

Choose a reason for hiding this comment

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

Fixed.

Copy link
Member

Choose a reason for hiding this comment

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

(That's definitely not proper english)


DLLs copied in the source tree are now always packaged; the
``package_data.dlls`` entry has no effect anymore. If you do not want to
include the DLLs, don't copy them into the source tree.
Copy link
Contributor

Choose a reason for hiding this comment

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

FWIW same comment as before about “don't” vs. “do not”.

@NelleV NelleV merged commit 9a1873f into matplotlib:master Sep 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants