diff --git a/docs/source/conf.py b/docs/source/conf.py index 1404a2a..7e00184 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -70,10 +70,11 @@ # "transformers": ("https://huggingface.co/transformers/", None), "optuna": ("https://optuna.readthedocs.io/en/stable/", None), "mlflow": ("https://www.mlflow.org/docs/latest/", None), - "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None), + "scipy": ("https://docs.scipy.org/doc/scipy/", None), "numpy": ("https://numpy.org/doc/stable/", None), "git": ("https://gitpython.readthedocs.io/en/stable/", None), "platformdirs": ("https://platformdirs.readthedocs.io/en/latest/", None), + #"matplotlib": ("https://matplotlib.org/stable/", None), } # html_logo = "imgs/xxx.png" diff --git a/mltb2/plot.py b/mltb2/plot.py index 2ef3d09..db7cf46 100644 --- a/mltb2/plot.py +++ b/mltb2/plot.py @@ -33,7 +33,9 @@ def twin_axes_timeseries_plot( """Create twin axes timeseries plot. Plots two different timeseries curves in one diagram but two different y-axes. - This function does not call `matplotlib.pyplot.plot()`. + + Hint: + This function does not use `matplotlib.pyplot.plot`. Args: values_1: (``array_like``) Values for the first timeseries curve. @@ -90,7 +92,8 @@ def boxplot( ): """Prints one or more boxplots in a single diagram. - This function does not call `matplotlib.pyplot.plot()`. + Hint: + This function does not use `matplotlib.pyplot.plot`. Args: values: Values for the boxplot(s). @@ -133,7 +136,8 @@ def boxplot_dict( ): """Create boxplot form dictionary. - This function does not call `matplotlib.pyplot.plot()`. + Hint: + This function does not use `matplotlib.pyplot.plot`. Args: values_dict: Dictionary with values for the boxplot(s). @@ -154,7 +158,7 @@ def boxplot_dict( def save_last_figure(filename): - """Saves the last plot. + """Saves the last plot made by Matplotlib. For jupyter notebooks this has to be called in the same cell that created the plot. """