8000 DOC: fix references and table · matplotlib/matplotlib@e324271 · GitHub
[go: up one dir, main page]

Skip to content

Commit e324271

Browse files
committed
DOC: fix references and table
1 parent 26f1a90 commit e324271

File tree

2 files changed

+22
-17
lines changed

2 files changed

+22
-17
lines changed

doc/users/next_whats_new/2019-03-25-mplot3d-projection.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,18 @@ stretched to fit a square bounding box. As this stretching was done after
66
the projection from 3D to 2D, it resulted in distorted images if non-square
77
bounding boxes were used. As of this release, this no longer occurs by default.
88

9-
We have extended the functionality of `.Axes3D.set_aspect` to accept
10-
the modes ``'auto_Pb'``, which uses a fixed ratios between the sizes,
11-
in display space, of the axis. To control these ratios use the
12-
`.Axes3D.set_box_aspect` method which accepts the ratios at as a
13-
3-tuple of X:Y:Z. The default aspect ratio is 4:4:3.
9+
We have extended the functionality of
10+
`~mpl_toolkits.mplot3d.axes3d.Axes3D.set_aspect` to accept the modes
11+
``'auto_Pb'``, which uses a fixed ratios between the sizes, in display
12+
space, of the axis. To control these ratios use the
13+
`~mpl_toolkits.mplot3d.axes3d.Axes3D.set_box_aspect` method which
14+
accepts the ratios at as a 3-tuple of X:Y:Z. The default aspect ratio
15+
is 4:4:3.
1416

1517
Currently modes of setting the aspect, in data space, are not
1618
supported for Axes3D but maybe in the future. If you want to simulate
1719
having equal aspect in data space, set the ratio of your data limits
18-
to match the value of `.Axes3D.get_box_aspect`.
20+
to match the value of `~.get_box_aspect`.
1921

2022
To restore the old behavior (which may result in distorted images) use
2123
``ax.set_aspect('auto')``.

lib/mpl_toolkits/mplot3d/axes3d.py

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -275,16 +275,16 @@ def set_aspect(self, aspect, adjustable=None, anchor=None, share=False):
275275
aspect : {'auto_pb', 'auto'}
276276
Possible values:
277277
278-
======== ==================================================
279-
value description
280-
======== ==================================================
281-
'auto_pb' This will make the size of the axes have a fixed
282-
ratio
283-
'auto' automatic; fill the position rectangle with data.
284-
This will let the ratio between the size of the
285-
(pseudo-) bounding box be free and will not
286-
adjust anything at draw time.
287-
======== ==================================================
278+
========= ==================================================
279+
value description
280+
========= ==================================================
281+
'auto_pb' This will make the size of the axes have a fixed
282+
ratio
283+
'auto' automatic; fill the position rectangle with data.
284+
This will let the ratio between the size of the
285+
(pseudo-) bounding box be free and will not
286+
Ppadjust anything at draw time.
287+
========= ==================================================
288288
289289
adjustable : None or {'box', 'datalim'}, optional
290290
If not ``None``, this defines which parameter will be adjusted to
@@ -313,6 +313,9 @@ def set_aspect(self, aspect, adjustable=None, anchor=None, share=False):
313313
share : bool, default: False
314314
If ``True``, apply the settings to all shared Axes.
315315
316+
See Also
317+
--------
318+
mpl_toolkits.mplot3d.axes3d.Axes3D.set_box_aspect
316319
"""
317320
if aspect not in {'auto', 'auto_pb'}:
318321
raise NotImplementedError(
@@ -376,7 +379,7 @@ def set_box_aspect(self, aspect, zoom=1):
376379
377380
See Also
378381
--------
379-
matplotlib.axes.Axes3D.set_aspect
382+
mpl_toolkits.mplot3d.axes3d.Axes3D.set_aspect
380383
for a description of aspect handling.
381384
"""
382385
if aspect is None:

0 commit comments

Comments
 (0)
0