Skip to content

DOC: mark mosaic as no longer provisional #24891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/users/next_whats_new/per_subplot_mosaic.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
``subplot_mosaic`` no longer provisional
----------------------------------------

The API on `.Figure.subplot_mosaic` and `.pyplot.subplot_mosaic` are now
considered stable and will change under Matplotlib's normal deprecation
process.


Per-subplot keyword arguments in ``subplot_mosaic``
----------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion doc/users/prev_whats_new/whats_new_3.3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ or as a string (with single-character Axes labels):
ha='center', va='center', fontsize=36,
color='darkgrey')

See :doc:`/tutorials/provisional/mosaic` for more details and examples.
See :doc:`/gallery/subplots_axes_and_figures/mosaic` for more details and examples.

``GridSpec.subplots()``
-----------------------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
"""
=======================================
Complex and semantic figure composition
=======================================
.. redirect-from:: /tutorials/provisional/mosaic

.. warning::

This tutorial documents experimental / provisional API.
We are releasing this in v3.3 to get user feedback. We may
make breaking changes in future versions with no warning.

========================================================
Complex and semantic figure composition (subplot_mosaic)
========================================================

Laying out Axes in a Figure in a non-uniform grid can be both tedious
and verbose. For dense, even grids we have `.Figure.subplots` but for
Expand Down
7 changes: 1 addition & 6 deletions lib/matplotlib/figure.py
Original file line number Diff line number Diff line change
Expand Up @@ -1797,12 +1797,7 @@ def subplot_mosaic(self, mosaic, *, sharex=False, sharey=False,

This is a helper function to build complex GridSpec layouts visually.

.. note::

This API is provisional and may be revised in the future based on
early user feedback.

See :doc:`/tutorials/provisional/mosaic`
See :doc:`/gallery/subplots_axes_and_figures/mosaic`
for an example and full API documentation

Parameters
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/pyplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -1504,7 +1504,7 @@ def subplot_mosaic(mosaic, *, sharex=False, sharey=False,
This API is provisional and may be revised in the future based on
early user feedback.

See :doc:`/tutorials/provisional/mosaic`
See :doc:`/gallery/subplots_axes_and_figures/mosaic`
for an example and full API documentation

Parameters
Expand Down
10 changes: 6 additions & 4 deletions tutorials/intermediate/arranging_axes.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@

`~matplotlib.pyplot.subplot_mosaic`
A simple way to create figures and a grid of Axes, with the added
flexibility that Axes can also span rows or columns. The Axes
are returned in a labelled dictionary instead of an array. See also
`.Figure.subplot_mosaic` and :doc:`/tutorials/provisional/mosaic`.
flexibility that Axes can also span rows or columns. The Axes are returned
in a labelled dictionary instead of an array. See also
`.Figure.subplot_mosaic` and
:doc:`/gallery/subplots_axes_and_figures/mosaic`.

Sometimes it is natural to have more than one distinct group of Axes grids,
in which case Matplotlib has the concept of `.SubFigure`:
Expand Down Expand Up @@ -393,7 +394,8 @@ def squiggle_xy(a, b, c, d, i=np.arange(0.0, 2*np.pi, 0.05)):
# More reading
# ============
#
# - More details about :doc:`subplot mosaic </tutorials/provisional/mosaic>`.
# - More details about :doc:`subplot mosaic
# </gallery/subplots_axes_and_figures/mosaic>`.
# - More details about :doc:`constrained layout
# </tutorials/intermediate/constrainedlayout_guide>`, used to align
# spacing in most of these examples.
Expand Down
2 changes: 1 addition & 1 deletion tutorials/introductory/quick_start.py
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ def my_plotter(ax, data1, data2, param_dict):
###############################################################################
# Matplotlib has quite sophisticated tools for arranging Axes: See
# :doc:`/tutorials/intermediate/arranging_axes` and
# :doc:`/tutorials/provisional/mosaic`.
# :doc:`/gallery/subplots_axes_and_figures/mosaic`.
#
#
# More reading
Expand Down