Skip to content

Commit 3a425b7

Browse files
committed
DOC: Explain return value of seconadary_x/yaxis
Follow up to matplotlib#31405.
1 parent 49fd492 commit 3a425b7

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lib/matplotlib/axes/_secondary_axes.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,11 @@ def set_color(self, color):
329329
Returns
330330
-------
331331
ax : axes._secondary_axes.SecondaryAxis
332+
The returned Axes is overlaid on top of the original Axes and all
333+
components except for the complementary axis are hidden. You may modify
334+
the complementary axis, e.g. by setting ticks or an axis label. However,
335+
it is not designed to hold data, so that you should not call any
336+
plotting methods on it.
332337
333338
Other Parameters
334339
----------------

0 commit comments

Comments
 (0)