DOC: organize figure API · matplotlib/matplotlib@7b579a6 · GitHub
Skip to content

Commit 7b579a6

Browse files
jklymakjklymak
committed
DOC: organize figure API
1 parent 14a0c5b commit 7b579a6

11 files changed

Lines changed: 348 additions & 31 deletions

File tree

‎doc/api/figure_api.rst‎

Lines changed: 308 additions & 2 deletions

‎doc/api/prev_api_changes/api_changes_3.4.2.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Behaviour changes
77
Rename first argument to ``subplot_mosaic``
88
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99

10-
Both `.FigureBase.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
10+
Both `.Figure.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
1111
first position argument renamed from *layout* to *mosaic*. This is because we
1212
are considering to consolidate *constrained_layout* and *tight_layout* keyword
1313
arguments in the Figure creation functions of `.pyplot` into a single *layout*

‎doc/api/prev_api_changes/api_changes_3.5.0/behaviour.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Behaviour changes
44
First argument to ``subplot_mosaic`` renamed
55
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66

7-
Both `.FigureBase.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
7+
Both `.Figure.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
88
first positional argument renamed from *layout* to *mosaic*. As we have
99
consolidated the *constrained_layout* and *tight_layout* keyword arguments in
1010
the Figure creation functions of `.pyplot` into a single *layout* keyword

‎doc/users/prev_whats_new/whats_new_3.4.0.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -634,8 +634,8 @@ supxlabel and supylabel
634634
-----------------------
635635

636636
It is possible to add x- and y-labels to a whole figure, analogous to
637-
`.FigureBase.suptitle` using the new `.FigureBase.supxlabel` and
638-
`.FigureBase.supylabel` methods.
637+
`.Figure.suptitle` using the new `.Figure.supxlabel` and
638+
`.Figure.supylabel` methods.
639639

640640
.. plot::
641641

‎galleries/examples/subplots_axes_and_figures/figure_title.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
66
Each axes can have a title (or actually three - one each with *loc* "left",
77
"center", and "right"), but is sometimes desirable to give a whole figure
8-
(or `.SubFigure`) an overall title, using `.FigureBase.suptitle`.
8+
(or `.SubFigure`) an overall title, using `.Figure.suptitle`.
99
10-
We can also add figure-level x- and y-labels using `.FigureBase.supxlabel` and
11-
`.FigureBase.supylabel`.
10+
We can also add figure-level x- and y-labels using `.Figure.supxlabel` and
11+
`.Figure.supylabel`.
1212
"""
1313

1414
import matplotlib.pyplot as plt
@@ -31,8 +31,8 @@
3131
fig.suptitle('Different types of oscillations', fontsize=16)
3232

3333
# %%
34-
# A global x- or y-label can be set using the `.FigureBase.supxlabel` and
35-
# `.FigureBase.supylabel` methods.
34+
# A global x- or y-label can be set using the `.Figure.supxlabel` and
35+
# `.Figure.supylabel` methods.
3636

3737

3838
with get_sample_data('Stocks.csv') as file:

‎galleries/examples/subplots_axes_and_figures/gridspec_nested.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
set the position for a nested grid of subplots.
88
99
Note that the same functionality can be achieved more directly with
10-
`~.FigureBase.subfigures`; see
10+
`~.Figure.subfigures`; see
1111
:doc:`/gallery/subplots_axes_and_figures/subfigures`.
1212
1313
"""

‎galleries/users_explain/axes/arranging_axes.py‎

Lines changed: 2 additions & 0 deletions

0 commit comments

Comments
 (0)