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

Skip to content

Commit b2a42eb

Browse files
tacaswelltacaswell
committed
DOC: merge in remaining API deprecation docs
These were being stashed in the old place we kept them and got missed on the first pass.
1 parent 79ce3ea commit b2a42eb

8 files changed

Lines changed: 69 additions & 79 deletions

‎doc/api/api_changes/171014-AL-tickprops.rst‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎doc/api/api_changes/2018-08-17-AL-deprecations.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎doc/api/api_changes/2018-10-08-AL-deprecations.rst‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎doc/api/api_changes/2018-10-09-AL-deprecations.rst‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎doc/api/api_changes/2018-10-10-AL.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎doc/api/api_changes/2018-12-20-AL-deprecations.rst‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎doc/api/api_changes/2019-02-11-PGE.rst‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎doc/api/prev_api_changes/api_changes_3.1.0.rst‎

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,26 @@ non-callable), the exception would be silently ignored and the default
411411
formatter be used instead. This is no longer the case; the exception
412412
is now propagated out.
413413

414+
Deprecation of redundant `Tick` attributes
415+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
416+
417+
The ``gridOn``, ``tick1On``, ``tick2On``, ``label1On``, and ``label2On``
418+
`~.Tick` attributes have been deprecated. Directly get and set the visibility
419+
on the underlying artists, available as the ``gridline``, ``tick1line``,
420+
``tick2line``, ``label1``, and ``label2`` attributes.
421+
422+
The ``label`` attribute, which was an alias for ``label1``, has been
423+
deprecated.
424+
425+
Subclasses that relied on setting the above visibility attributes needs to be
426+
updated; see e.g. :file:`examples/api/skewt.py`.
427+
428+
Passing a Line2D's drawstyle together with the linestyle is deprecated
429+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
430+
431+
Instead of ``plt.plot(..., linestyle="steps--")``, use ``plt.plot(...,
432+
linestyle="--", drawstyle="steps")``. ``ds`` is now an alias for ``drawstyle``.
433+
414434

415435
``pgi`` support dropped
416436
-----------------------
@@ -461,6 +481,12 @@ Exception changes
461481
a `RuntimeError` if they were called with a ``data`` kwarg and
462482
otherwise mismatched arguments. They now raise a `TypeError`
463483
instead.
484+
- `.Axes.streamplot` does not support irregularly gridded ``x`` and ``y`` values.
485+
So far, it used to silently plot an incorrect result. This has been changed to
486+
raise a `ValueError` instead.
487+
- The `.streamplot.Grid` class, which is internally used by streamplot
488+
code, also throws a `ValueError` when irregularly gridded values are
489+
passed in.
464490

465491
Removals
466492
--------
@@ -849,6 +875,37 @@ future version.
849875
- `.cbook.is_hashable`
850876
Use ``isinstance(..., collections.abc.Hashable)`` instead.
851877

878+
- The `.backend_bases.RendererBase.strip_math`. Use
879+
`.cbook.strip_math` instead.
880+
881+
Multiple internal functions that were exposed as part of the public API
882+
of `.mpl_toolkits.mplot3d` are deprecated,
883+
884+
**mpl_toolkits.mplot3d.art3d**
885+
886+
- :func:`mpl_toolkits.mplot3d.art3d.norm_angle`
887+
- :func:`mpl_toolkits.mplot3d.art3d.norm_text_angle`
888+
- :func:`mpl_toolkits.mplot3d.art3d.path_to_3d_segment`
889+
- :func:`mpl_toolkits.mplot3d.art3d.paths_to_3d_segments`
890+
- :func:`mpl_toolkits.mplot3d.art3d.path_to_3d_segment_with_codes`
891+
- :func:`mpl_toolkits.mplot3d.art3d.paths_to_3d_segments_with_codes`
892+
- :func:`mpl_toolkits.mplot3d.art3d.get_patch_verts`
893+
- :func:`mpl_toolkits.mplot3d.art3d.get_colors`
894+
- :func:`mpl_toolkits.mplot3d.art3d.zalpha`
895+
896+
**mpl_toolkits.mplot3d.proj3d**
897+
898+
- :func:`mpl_toolkits.mplot3d.proj3d.line2d`
899+
- :func:`mpl_toolkits.mplot3d.proj3d.line2d_dist`
900+
- :func:`mpl_toolkits.mplot3d.proj3d.line2d_seg_dist`
901+
- :func:`mpl_toolkits.mplot3d.proj3d.mod`
902+
- :func:`mpl_toolkits.mplot3d.proj3d.proj_transform_vec`
903+
- :func:`mpl_toolkits.mplot3d.proj3d.proj_transform_vec_clip`
904+
- :func:`mpl_toolkits.mplot3d.proj3d.vec_pad_ones`
905+
- :func:`mpl_toolkits.mplot3d.proj3d.proj_trans_clip_points`
906+
907+
If your project relies on these functions, consider vendoring them.
908+
852909

853910
Font Handling
854911
~~~~~~~~~~~~~
@@ -914,8 +971,10 @@ GUI / backend details
914971
as it is a module-level global, no deprecation warning is emitted when
915972
accessing it).
916973
- `.mlab.demean`
917-
918-
974+
- ``backend_gtk3cairo.FigureCanvasGTK3Cairo``,
975+
- ``backend_wx.debug_on_error``, ``backend_wx.fake_stderr``,
976+
``backend_wx.raise_msg_to_str``, ``backend_wx.MenuButtonWx``,
977+
``backend_wx.PrintoutWx``,
919978
- ``matplotlib.backends.qt_editor.formlayout`` module
920979

921980
This module is a vendored, modified version of the official formlayout_ module
@@ -1074,6 +1133,14 @@ updated to use `~.Formatter.format_ticks`.
10741133
subclasses for which the formatting of a tick value depends on other tick
10751134
values, such as `.ConciseDateFormatter`.
10761135

1136+
Added support for RGB(A) images in pcolorfast
1137+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1138+
1139+
pcolorfast now accepts 3D images (RGB or RGBA) arrays if the X and Y
1140+
specifications allow image or pcolorimage rendering; they remain unsupported by
1141+
the more general quadmesh rendering
1142+
1143+
10771144
Invalid inputs
10781145
--------------
10791146

0 commit comments

Comments
 (0)