From 0899ad56c55990b91e76437a1f73327f27b2a2da Mon Sep 17 00:00:00 2001 From: Alexander James Date: Fri, 31 May 2024 12:05:43 -0700 Subject: [PATCH] minor docstrings fixes --- doc_build/core/api.rst | 4 ++-- pyleoclim/core/ensembleseries.py | 4 ++-- pyleoclim/core/resolutions.py | 13 ++++++++----- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/doc_build/core/api.rst b/doc_build/core/api.rst index 612baa05..dc6482ad 100644 --- a/doc_build/core/api.rst +++ b/doc_build/core/api.rst @@ -122,13 +122,13 @@ SsaRes (pyleoclim.SsaRes) :members: Resolution (pyleoclim.Resolution) -""""""""""""""""""""""""""""""""""""""""" +""""""""""""""""""""""""""""""""" .. autoclass:: pyleoclim.core.resolutions.Resolution :members: MultipleResolution (pyleoclim.MultipleResolution) -""""""""""""""""""""""""""""""""""""""""" +""""""""""""""""""""""""""""""""""""""""""""""""" .. autoclass:: pyleoclim.core.resolutions.MultipleResolution :members: \ No newline at end of file diff --git a/pyleoclim/core/ensembleseries.py b/pyleoclim/core/ensembleseries.py index df5f9650..d884150d 100644 --- a/pyleoclim/core/ensembleseries.py +++ b/pyleoclim/core/ensembleseries.py @@ -1297,8 +1297,8 @@ def to_array(self, axis='value', labels=True): headers: list A list of corresponding labels for each columm - Example - ------- + Examples + -------- .. jupyter-execute:: diff --git a/pyleoclim/core/resolutions.py b/pyleoclim/core/resolutions.py index 9c3fb373..31fc9a8d 100644 --- a/pyleoclim/core/resolutions.py +++ b/pyleoclim/core/resolutions.py @@ -473,12 +473,13 @@ class MultipleResolution: resolution_list : list List of resolution objects. + time_unit : str The unit of time for the resolution. See Also -------- - + Resolution : The base class from which MultipleResolution is derived. ''' @@ -554,13 +555,14 @@ def summary_plot(self,figsize=(10,8),xlabel=None,ylabel=None,legend=False,ax=Non Examples -------- .. jupyter-execute:: + import pyleoclim as pyleo co2ts = pyleo.utils.load_dataset('AACO2') edc = pyleo.utils.load_dataset('EDC-dD') ms = edc & co2ts # create MS object - ms_resolution = ms.resolution() - ms_resolution.plot() + ms_resolution = ms.resolution(statistic=None) + ms_resolution.summary_plot() """ boxplot_kwargs = {} if boxplot_kwargs is None else boxplot_kwargs.copy() @@ -638,13 +640,14 @@ def describe(self): -------- ..jupyter-execute:: + import pyleoclim as pyleo co2ts = pyleo.utils.load_dataset('AACO2') edc = pyleo.utils.load_dataset('EDC-dD') ms = edc & co2ts # create MS object - ms_resolution = ms.resolution() - ms_resolution.plot() + ms_resolution = ms.resolution(statistic=None) + ms_resolution.describe() '''