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

Skip to content

Commit 1d46a93

Browse files
anntzerImportanceOfBeingErnest
authored andcommitted
Add get/set_in_layout to artist API docs. (#13436)
They don't seem to fit in any existing subsection and creating a section just for them seems silly, so move them, together with other single-entry subsections, to "misc.". To compensate the loss of the "margins and autoscaling subsection", add mention of autoscaling in the first line of the sticky_edges docstring, to keep that term ctrl-f'able on the API docs page.
1 parent 46a704e commit 1d46a93

2 files changed

Lines changed: 8 additions & 14 deletions

File tree

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.get_picker
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

@@ -171,13 +162,16 @@ Metadata
171162
Artist.set_url
172163
Artist.get_url
173164

174-
Stale
175-
-----
165+
Miscellaneous
166+
-------------
176167

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

172+
Artist.sticky_edges
173+
Artist.set_in_layout
174+
Artist.get_in_layout
181175
Artist.stale
182176

183177
Functions

lib/matplotlib/artist.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -998,16 +998,16 @@ def set_zorder(self, level):
998998
@property
999999
def sticky_edges(self):
10001000
"""
1001-
`x` and `y` sticky edge lists.
1001+
``x`` and ``y`` sticky edge lists for autoscaling.
10021002
10031003
When performing autoscaling, if a data limit coincides with a value in
10041004
the corresponding sticky_edges list, then no margin will be added--the
10051005
view limit "sticks" to the edge. A typical use case is histograms,
10061006
where one usually expects no margin on the bottom edge (0) of the
10071007
histogram.
10081008
1009-
This attribute cannot be assigned to; however, the `x` and `y` lists
1010-
can be modified in place as needed.
1009+
This attribute cannot be assigned to; however, the ``x`` and ``y``
1010+
lists can be modified in place as needed.
10111011
10121012
Examples
10131013
--------

0 commit comments

Comments
 (0)