From 22d75a8c3531e8412e8e9ae47a32612490efabba Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Fri, 16 Apr 2021 17:40:46 -0400 Subject: [PATCH] DOC: add note about axes order to docstring --- lib/matplotlib/figure.py | 4 +++- lib/matplotlib/pyplot.py | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py index f138f4d3f838..483ff414238f 100644 --- a/lib/matplotlib/figure.py +++ b/lib/matplotlib/figure.py @@ -1738,7 +1738,9 @@ def subplot_mosaic(self, layout, *, subplot_kw=None, gridspec_kw=None, Returns ------- dict[label, Axes] - A dictionary mapping the labels to the Axes objects. + A dictionary mapping the labels to the Axes objects. The order of + the axes is left-to-right and top-to-bottom of their position in the + total layout. """ subplot_kw = subplot_kw or {} diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py index 48ef211671f4..2ea45ba2ad45 100644 --- a/lib/matplotlib/pyplot.py +++ b/lib/matplotlib/pyplot.py @@ -1500,7 +1500,9 @@ def subplot_mosaic(layout, *, subplot_kw=None, gridspec_kw=None, The new figure dict[label, Axes] - A dictionary mapping the labels to the Axes objects. + A dictionary mapping the labels to the Axes objects. The order of + the axes is left-to-right and top-to-bottom of their position in the + total layout. """ fig = figure(**fig_kw)