From 462c1a9bc1b707f0ca33476e4282ff2dc1ffcb31 Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson Date: Wed, 8 Mar 2023 09:16:57 +0100 Subject: [PATCH] Improve/correct documentation --- lib/matplotlib/axes/_axes.py | 2 +- lib/matplotlib/patches.py | 3 +++ lib/matplotlib/widgets.py | 6 ++++++ lib/mpl_toolkits/mplot3d/art3d.py | 2 +- 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index 5354d8fd79f2..be016a53e5ae 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -3115,7 +3115,7 @@ def pie(self, x, explode=None, labels=None, colors=None, ``fmt % pct``. If *autopct* is a function, then it will be called. pctdistance : float, default: 0.6 - The relative distance along the radius at which the the text + The relative distance along the radius at which the text generated by *autopct* is drawn. To draw the text outside the pie, set *pctdistance* > 1. This parameter is ignored if *autopct* is ``None``. diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py index e60a14f592fb..25261de1442d 100644 --- a/lib/matplotlib/patches.py +++ b/lib/matplotlib/patches.py @@ -3083,6 +3083,9 @@ class ArrowStyle(_Style): %(ArrowStyle:table)s + For an overview of the visual appearance, see + :doc:`/gallery/text_labels_and_annotations/fancyarrow_demo`. + An instance of any arrow style class is a callable object, whose call signature is:: diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py index c25644dbe6b8..ebe5da43e28c 100644 --- a/lib/matplotlib/widgets.py +++ b/lib/matplotlib/widgets.py @@ -188,6 +188,8 @@ def __init__(self, ax, label, image=None, useblit : bool, default: True Use blitting for faster drawing if supported by the backend. See the tutorial :doc:`/tutorials/advanced/blitting` for details. + + .. versionadded:: 3.7 """ super().__init__(ax) @@ -1029,6 +1031,8 @@ def __init__(self, ax, labels, actives=None, *, useblit=True, useblit : bool, default: True Use blitting for faster drawing if supported by the backend. See the tutorial :doc:`/tutorials/advanced/blitting` for details. + + .. versionadded:: 3.7 label_props : dict, optional Dictionary of `.Text` properties to be used for the labels. @@ -1634,6 +1638,8 @@ def __init__(self, ax, labels, active=0, activecolor=None, *, useblit : bool, default: True Use blitting for faster drawing if supported by the backend. See the tutorial :doc:`/tutorials/advanced/blitting` for details. + + .. versionadded:: 3.7 label_props : dict or list of dict, optional Dictionary of `.Text` properties to be used for the labels. diff --git a/lib/mpl_toolkits/mplot3d/art3d.py b/lib/mpl_toolkits/mplot3d/art3d.py index 3afd8f216475..39805142a5ac 100644 --- a/lib/mpl_toolkits/mplot3d/art3d.py +++ b/lib/mpl_toolkits/mplot3d/art3d.py @@ -848,7 +848,7 @@ def __init__(self, verts, *args, zsort='average', shade=False, .. versionadded:: 3.7 - lightsource : `~matplotlib.colors.LightSource` + lightsource : `~matplotlib.colors.LightSource`, optional The lightsource to use when *shade* is True. .. versionadded:: 3.7