8000 Merge pull request #13437 from meeseeksmachine/auto-backport-of-pr-13… · matplotlib/matplotlib@16fdf8d · GitHub
[go: up one dir, main page]

Skip to content

Commit 16fdf8d

Browse files
authored
Merge pull request #13437 from meeseeksmachine/auto-backport-of-pr-13436-on-v3.0.x
Backport PR #13436 on branch v3.0.x (Add get/set_in_layout to artist API docs.)
2 parents c3653e4 + f6ba71a commit 16fdf8d

File tree

2 files changed

+8
-14
lines changed

2 files changed

+8
-14
lines changed

doc/api/artist_api.rst

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,6 @@ Interactive
4343
Artist.set_picker
4444
Artist.contains
4545

46-
Margins and Autoscaling
47-
-----------------------
48-
49-
.. autosummary::
50-
:toctree: _as_gen
51-
:nosignatures:
52-
53-
Artist.sticky_edges
54-
5546
Clipping
5647
--------
5748

@@ -172,13 +163,16 @@ Metadata
172163
Artist.set_url
173164
Artist.aname
174165

175-
Stale
176-
-----
166+
Miscellaneous
167+
-------------
177168

178169
.. autosummary::
179170
:toctree: _as_gen
180171
:nosignatures:
181172

173+
Artist.sticky_edges
174+
Artist.set_in_layout
175+
Artist.get_in_layout
182176
Artist.stale
183177

184178
Functions

lib/matplotlib/artist.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -962,16 +962,16 @@ def set_zorder(self, level):
962962
@property
963963
def sticky_edges(self):
964964
"""
965-
`x` and `y` sticky edge lists.
965+
``x`` and ``y`` sticky edge lists for autoscaling.
966966
967967
When performing autoscaling, if a data limit coincides with a value in
968968
the corresponding sticky_edges list, then no margin will be added--the
969969
view limit "sticks" to the edge. A typical usecase is histograms,
970970
where one usually expects no margin on the bottom edge (0) of the
971971
histogram.
972972
973-
This attribute cannot be assigned to; however, the `x` and `y` lists
974-
can be modified in place as needed.
973+
This attribute cannot be assigned to; however, the ``x`` and ``y``
974+
lists can be modified in place as needed.
975975
976976
Examples
977977
--------

0 commit comments

Comments
 (0)
0