|
| 1 | +Deprecations |
| 2 | +------------ |
| 3 | + |
| 4 | +``contour`` deprecations reverted |
| 5 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 6 | + |
| 7 | +``contour.allsegs``, ``contour.allkinds``, and ``contour.find_nearest_contour`` are no |
| 8 | +longer marked for deprecation. |
| 9 | + |
| 10 | +``plot_date`` |
| 11 | +^^^^^^^^^^^^^ |
| 12 | + |
| 13 | +Use of `~.Axes.plot_date` has been discouraged since Matplotlib 3.5 and the function is |
| 14 | +now formally deprecated. |
| 15 | + |
| 16 | +- ``datetime``-like data should directly be plotted using `~.Axes.plot`. |
| 17 | +- If you need to plot plain numeric data as :ref:`date-format` or need to set a |
| 18 | + timezone, call ``ax.xaxis.axis_date`` / ``ax.yaxis.axis_date`` before `~.Axes.plot`. |
| 19 | + See `.Axis.axis_date`. |
| 20 | + |
| 21 | +Legend labels for ``plot`` |
| 22 | +^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 23 | + |
| 24 | +Previously if a sequence was passed to the *label* parameter of `~.Axes.plot` when |
| 25 | +plotting a single dataset, the sequence was automatically cast to string for the legend |
| 26 | +label. This behavior is now deprecated and in future will error if the sequence length |
| 27 | +is not one (consistent with multi-dataset behavior, where the number of elements must |
| 28 | +match the number of datasets). To keep the old behavior, cast the sequence to string |
| 29 | +before passing. |
| 30 | + |
| 31 | +``boxplot`` tick labels |
| 32 | +^^^^^^^^^^^^^^^^^^^^^^^ |
| 33 | + |
| 34 | +The parameter *labels* has been renamed to *tick_labels* for clarity and consistency |
| 35 | +with `~.Axes.bar`. |
| 36 | + |
| 37 | +Mixing positional and keyword arguments for ``legend`` handles and labels |
| 38 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 39 | + |
| 40 | +This previously only raised a warning, but is now formally deprecated. If passing |
| 41 | +*handles* and *labels*, they must be passed either both positionally or both as keyword. |
| 42 | + |
| 43 | +Applying theta transforms in ``PolarTransform`` |
| 44 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 45 | + |
| 46 | +Applying theta transforms in `~matplotlib.projections.polar.PolarTransform` and |
| 47 | +`~matplotlib.projections.polar.InvertedPolarTransform` is deprecated, and will be |
| 48 | +removed in a future version of Matplotlib. This is currently the default behaviour when |
| 49 | +these transforms are used externally, but only takes affect when: |
| 50 | + |
| 51 | +- An axis is associated with the transform. |
| 52 | +- The axis has a non-zero theta offset or has theta values increasing in a clockwise |
| 53 | + direction. |
| 54 | + |
| 55 | +To silence this warning and adopt future behaviour, set |
| 56 | +``apply_theta_transforms=False``. If you need to retain the behaviour where theta values |
| 57 | +are transformed, chain the ``PolarTransform`` with a `~matplotlib.transforms.Affine2D` |
| 58 | +transform that performs the theta shift and/or sign shift. |
| 59 | + |
| 60 | +*interval* parameter of ``TimerBase.start`` |
| 61 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 62 | + |
| 63 | +Setting the timer *interval* while starting it is deprecated. The interval can be |
| 64 | +specified instead in the timer constructor, or by setting the ``timer.interval`` |
| 65 | +attribute. |
| 66 | + |
| 67 | +*nth_coord* parameter to axisartist helpers for fixed axis |
| 68 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 69 | + |
| 70 | +Helper APIs in `.axisartist` for generating a "fixed" axis on rectilinear axes |
| 71 | +(`.FixedAxisArtistHelperRectilinear`) no longer take a *nth_coord* parameter, as that |
| 72 | +parameter is entirely inferred from the (required) *loc* parameter and having |
| 73 | +inconsistent *nth_coord* and *loc* is an error. |
| 74 | + |
| 75 | +For curvilinear axes, the *nth_coord* parameter remains supported (it affects the |
| 76 | +*ticks*, not the axis position itself), but that parameter will become keyword-only, for |
| 77 | +consistency with the rectilinear case. |
| 78 | + |
| 79 | +``rcsetup.interactive_bk``, ``rcsetup.non_interactive_bk`` and ``rcsetup.all_backends`` |
| 80 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 81 | + |
| 82 | +... are deprecated and replaced by ``matplotlib.backends.backend_registry.list_builtin`` |
| 83 | +with the following arguments |
| 84 | + |
| 85 | +- ``matplotlib.backends.BackendFilter.INTERACTIVE`` |
| 86 | +- ``matplotlib.backends.BackendFilter.NON_INTERACTIVE`` |
| 87 | +- ``None`` |
| 88 | + |
| 89 | +respectively. |
| 90 | + |
| 91 | +Miscellaneous deprecations |
| 92 | +^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 93 | + |
| 94 | +- ``backend_ps.get_bbox_header`` is considered an internal helper |
| 95 | +- ``BboxTransformToMaxOnly``; if you rely on this, please make a copy of the code |
| 96 | +- ``ContourLabeler.add_label_clabeltext`` |
| 97 | +- ``TransformNode.is_bbox``; instead check the object using ``isinstance(..., |
| 98 | + BboxBase)`` |
| 99 | +- ``GridHelperCurveLinear.get_tick_iterator`` |
0 commit comments