Skip to content

Commit

Permalink
DOCS: add deprecation notice for pandas column usage and clarify Arvi…
Browse files Browse the repository at this point in the history
…Z requirement (#218)
  • Loading branch information
zachjweiner committed Dec 3, 2022
1 parent f73df71 commit fccea83
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/corner/corner.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,14 @@ def corner(
respectively. If `None` (default), no smoothing is applied.
labels : iterable (ndim,)
A list of names for the dimensions. If a ``xs`` is a
``pandas.DataFrame``, labels will default to column names.
A list of names for the dimensions.
.. deprecated:: 2.2.1
If a ``xs`` is a ``pandas.DataFrame`` *and* ArviZ is installed,
labels will default to column names.
This behavior will be removed in version 3;
either use ArviZ data structures instead or pass
``labels=dataframe.columns`` manually.
label_kwargs : dict
Any extra keyword arguments to send to the `set_xlabel` and
Expand Down

0 comments on commit fccea83

Please sign in to comment.