Merge pull request #13437 from meeseeksmachine/auto-backport-of-pr-13436-on-v3.0.x

timhoffm · web-flow · commit 16fdf8d29a47 · 2019-02-14T23:57:39.000+01:00
Backport PR #13436 on branch v3.0.x (Add get/set_in_layout to artist API docs.)
diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst
@@ -43,15 +43,6 @@ Interactive
    Artist.set_picker
    Artist.contains
 
-Margins and Autoscaling
------------------------
-
-.. autosummary::
-   :toctree: _as_gen
-   :nosignatures:
-
-   Artist.sticky_edges
-
 Clipping
 --------
 
@@ -172,13 +163,16 @@ Metadata
    Artist.set_url
    Artist.aname
 
-Stale
------
+Miscellaneous
+-------------
 
 .. autosummary::
    :toctree: _as_gen
    :nosignatures:
 
+   Artist.sticky_edges
+   Artist.set_in_layout
+   Artist.get_in_layout
    Artist.stale
 
 Functions
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -962,16 +962,16 @@ def set_zorder(self, level):
     @property
     def sticky_edges(self):
         """
-        `x` and `y` sticky edge lists.
+        ``x`` and ``y`` sticky edge lists for autoscaling.
 
         When performing autoscaling, if a data limit coincides with a value in
         the corresponding sticky_edges list, then no margin will be added--the
         view limit "sticks" to the edge. A typical usecase is histograms,
         where one usually expects no margin on the bottom edge (0) of the
         histogram.
 
-        This attribute cannot be assigned to; however, the `x` and `y` lists
-        can be modified in place as needed.
+        This attribute cannot be assigned to; however, the ``x`` and ``y``
+        lists can be modified in place as needed.
 
         Examples
         --------
