From 36886a3d9631704cfca91953f32ac557dbe97954 Mon Sep 17 00:00:00 2001 From: Oriol Abril-Pla Date: Tue, 6 Dec 2022 14:32:35 +0100 Subject: [PATCH] fix chain_prop and compact_prop docs (#2176) * fix chain_prop and compact_prop docs * Update arviz/plots/traceplot.py * update changelog --- CHANGELOG.md | 1 + arviz/plots/traceplot.py | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a3e9a54467..1673a54ac9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ ### Documentation - Add PyMC and CmdStanPy sampling wrapper examples ([2158](https://github.com/arviz-devs/arviz/pull/2158)) +- Fix docstring for plot_trace chain_prop and compact_prop parameters ([2176](https://github.com/arviz-devs/arviz/pull/2176)) ## v0.14.0 (2022 Nov 15) diff --git a/arviz/plots/traceplot.py b/arviz/plots/traceplot.py index f8dbde5ad8..c462e89a63 100644 --- a/arviz/plots/traceplot.py +++ b/arviz/plots/traceplot.py @@ -82,13 +82,18 @@ def plot_trace( compact: bool, optional Plot multidimensional variables in a single plot. compact_prop: str or dict {str: array_like}, optional - Tuple containing the property name and the property values to distinguish different - dimensions with compact=True + Defines the property name and the property values to distinguish different + dimensions with compact=True. + When compact=True it defaults to color, it is + ignored otherwise. combined: bool, optional Flag for combining multiple chains into a single line. If False (default), chains will be plotted separately. chain_prop: str or dict {str: array_like}, optional - Tuple containing the property name and the property values to distinguish different chains + Defines the property name and the property values to distinguish different chains. + If compact=True it defaults to linestyle, + otherwise it uses the color to distinguish + different chains. legend: bool, optional Add a legend to the figure with the chain color code. plot_kwargs, fill_kwargs, rug_kwargs, hist_kwargs: dict, optional