Skip to content

Commit

Permalink
correct pictures paths in docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
MAfarrag committed Aug 25, 2024
1 parent d856aef commit 28a4ed5
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions statista/time_series.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ def box_plot(
.. image:: /_images/box_plot_1d.png
:align: center
- Plot the box plot for a 1D time series:
- Plot the box plot for a multiple time series:
>>> data_2d = np.random.randn(100, 4)
>>> ts_2d = TimeSeries(data_2d, columns=['A', 'B', 'C', 'D'])
Expand All @@ -208,17 +208,17 @@ def box_plot(
>>> fig, ax = ts_2d.box_plot(grid=True, mean=True, color={"boxes": "#DC143C"})
.. image:: /_images/box_plot_color.png
.. image:: /_images/times_series/box_plot_color.png
:align: center
>>> fig, ax = ts_2d.box_plot(xlabel='Custom X', ylabel='Custom Y', title='Custom Box Plot')
.. image:: /_images/box_plot_axes-label.png
.. image:: /_images/times_series/box_plot_axes-label.png
:align: center
>>> fig, ax = ts_2d.box_plot(notch=True)
.. image:: /_images/box_plot_notch.png
.. image:: /_images/times_series/box_plot_notch.png
:align: center
"""
fig, ax = self._get_ax_fig(fig=kwargs.get("fig"), ax=kwargs.get("ax"))
Expand Down Expand Up @@ -358,7 +358,14 @@ def violin(
>>> fig, ax = ts_2d.violin(mean=True, median=True, extrema=True)
.. image:: /_images/violin_means_medians_extrena.png
.. image:: /_images/times_series/violin_means_medians_extrena.png
:align: center
- You can display the violins on the low side only using the `side` parameter:
>>> fig, ax = ts_2d.violin(side='low')
.. image:: /_images/times_series/violin_low_side.png
:align: center
"""
fig, ax = self._get_ax_fig(fig=kwargs.get("fig"), ax=kwargs.get("ax"))
Expand Down

0 comments on commit 28a4ed5

Please sign in to comment.