Skip to content

Commit

Permalink
fix chain_prop and compact_prop docs (#2176)
Browse files Browse the repository at this point in the history
* fix chain_prop and compact_prop docs

* Update arviz/plots/traceplot.py

* update changelog
  • Loading branch information
OriolAbril authored Dec 6, 2022
1 parent af34307 commit 36886a3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
11 changes: 8 additions & 3 deletions arviz/plots/traceplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 36886a3

Please sign in to comment.