From a473604177df0829d16a5a27a0c1a9c4ea758ba7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20de=20Menten?= Date: Thu, 30 May 2024 13:08:37 +0200 Subject: [PATCH] DOC: better subplot docstring --- larray/core/array.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/larray/core/array.py b/larray/core/array.py index 65ed6033a..649a1d441 100644 --- a/larray/core/array.py +++ b/larray/core/array.py @@ -7134,15 +7134,19 @@ def plot(self) -> PlotObject: - 'hexbin' : hexbin plot (if array's dimensions >= 2) ax : matplotlib axes object, default None subplots : boolean, Axis, int, str or tuple, default False - Make several subplots. If True, will make subplots for each combination of labels for all axes except the - last. If an Axis, int, str (or tuple of those), it will make subplots for combination of labels of those - axes. + Make several subplots. + - if an Axis (or int or str), make subplots for each label of that axis. + - if a tuple of Axis (or int or str), make subplots for each combination of + labels of those axes. + - True is equivalent to all axes except the last. + Defaults to False. sharex : boolean, default True if ax is None else False - In case subplots=True, share x axis and set some x axis labels to invisible; + When subplots are used, share x axis and set some x axis labels to invisible; defaults to True if ax is None otherwise False if an ax is passed in; - Be aware, that passing in both an ax and sharex=True will alter all x axis labels for all axis in a figure! + Be aware, that passing in both an ax and sharex=True will alter all x axis + labels for all axis in a figure! sharey : boolean, default False - In case subplots=True, share y axis and set some y axis labels to invisible + When subplots are used, share y axis and set some y axis labels to invisible. layout : tuple (optional) (rows, columns) for the layout of subplots figsize : a tuple (width, height) in inches