File tree 2 files changed +22
-1
lines changed
2 files changed +22
-1
lines changed Original file line number Diff line number Diff line change @@ -645,6 +645,8 @@ class PlotAccessor(PandasObject):
645
645
with columns 'a' and 'c', and one with columns 'b' and 'd'.
646
646
Remaining columns that aren't specified will be plotted in
647
647
additional subplots (one per column).
648
+ .. versionadded:: 1.3.0
649
+
648
650
sharex : bool, default True if ax is None else False
649
651
In case ``subplots=True``, share x axis and set some x axis labels
650
652
to invisible; defaults to True if ax is None otherwise False if
Original file line number Diff line number Diff line change @@ -213,7 +213,26 @@ def __init__(
213
213
214
214
def _validate_subplots_kwarg (
215
215
self , subplots : Union [bool , Sequence [Sequence [str ]]]
216
- ) -> Union [bool , Sequence [Sequence [int ]]]:
216
+ ) -> Union [bool , List [Tuple [int ]]]:
217
+ """
218
+ Validate the subplots parameter
219
+
220
+ - check type and content
221
+ - check for duplicate columns
222
+ - check for invalid column names
223
+ - convert column names into indices
224
+ - add missing columns in a group of their own
225
+ See comments in code below for more details.
226
+
227
+ Parameters
228
+ ----------
229
+ subplots : subplots parameters as passed to PlotAccessor
230
+
231
+ Returns
232
+ -------
233
+ validated subplots : a bool or a list of tuples of column indices. Columns
234
+ in the same tuple will be grouped together in the resulting plot.
235
+ """
217
236
218
237
if isinstance (subplots , bool ):
219
238
return subplots
You can’t perform that action at this time.
0 commit comments