Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inconsistent capitalization in plot_hdi docstring #1221

Merged
merged 3 commits into from
Jun 4, 2020
Merged

Fix inconsistent capitalization in plot_hdi docstring #1221

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
509e1d4
Fix inconsistent capitalization in plot_hdi docstring
neha-shah99 Jun 4, 2020
05631df
Update Changelog
neha-shah99 Jun 4, 2020
464786f
Update CHANGELOG.md
neha-shah99 Jun 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions arviz/plots/hdiplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ def plot_hdi(
Parameters
----------
x : array-like
Values to plot
Values to plot.
y : array-like
values from which to compute the hdi. Assumed shape (chain, draw, \*shape).
Values from which to compute the hdi. Assumed shape (chain, draw, \*shape).
hdi_prob : float, optional
Probability for the highest density interval. Defaults to 0.94.
color : str
Color used for the limits of the hdi and fill. Should be a valid matplotlib color
Color used for the limits of the hdi and fill. Should be a valid matplotlib color.
circular : bool, optional
Whether to compute the hdi taking into account `x` is a circular variable
(in the range [-np.pi, np.pi]) or not. Defaults to False (i.e non-circular variables).
Expand All @@ -49,11 +49,11 @@ def plot_hdi(
Defaults to True.
smooth_kwargs : dict, optional
Additional keywords modifying the Savitzky-Golay filter. See Scipy's documentation for
details
details.
fill_kwargs : dict
Keywords passed to `fill_between` (use fill_kwargs={'alpha': 0} to disable fill).
plot_kwargs : dict
Keywords passed to hdi limits
Keywords passed to hdi limits.
ax: axes, optional
Matplotlib axes or bokeh figures.
backend: str, optional
Expand All @@ -64,7 +64,7 @@ def plot_hdi(
show : bool, optional
Call backend show function.
credible_interval: float, optional
deprecated: Please see hdi_prob
Deprecated: Please see hdi_prob

Returns
-------
Expand Down