Docstring fixes (#565)

* fix see also formatting

* add jupyter execute syntax

* Delete scratch.ipynb

---------

Co-authored-by: Alexander James <[email protected]>

pyleoclim/core/multipleseries.py

@@ -2532,7 +2532,7 @@ def resolution(self,time_unit=None,verbose=True,statistic='median'):
             If a recognized statistic is passed, this function will simply output that statistic applied to the resolution of each series in the MulitipleSeries object. Options are 'mean' or 'median'.
             If statistic is None, then the function will return a new MultipleResolution class with plotting capabilities.
 
-        See Also
+        See also
         --------
         
         pyleoclim.core.resolutions.MultipleResolution

pyleoclim/core/psds.py

@@ -380,6 +380,7 @@ def beta_est(self, fmin=None, fmax=None, logf_binning_step='max', verbose=False)
 
         See also
         --------
+
         pyleoclim.core.series.Series.spectral : spectral analysis
 
         pyleoclim.utils.spectral.beta_estimation : Estimate the scaling exponent of a power spectral density

pyleoclim/core/resolutions.py

@@ -41,8 +41,6 @@ class Resolution:
     timeseries : pyleoclim.Series
         Original pyleoclim timeseries object.
 
-    See Also
-    --------
 
     '''
 
@@ -385,9 +383,6 @@ def dashboard(self, figsize=[11, 8], title=None, plot_kwargs=None, histplot_kwar
 
             The axis
 
-        See also
-        --------
-
 
         Examples
         --------
@@ -474,7 +469,7 @@ class MultipleResolution:
     time_unit : str
         The unit of time for the resolution.
 
-    See Also
+    See also
     --------
 
     Resolution : The base class from which MultipleResolution is derived.

pyleoclim/core/series.py

@@ -4276,7 +4276,7 @@ def resolution(self):
         resolution : Resolution
             Resolution object
 
-        See Also
+        See also
         --------
 
         pyleoclim.core.resolutions.Resolution

pyleoclim/core/surrogateseries.py

@@ -107,7 +107,9 @@ def from_series(self, target_series):
         --------
 
         pyleoclim.utils.tsmodel.ar1_sim : AR(1) simulator
+
         pyleoclim.utils.tsmodel.uar1_sim : maximum likelihood AR(1) simulator
+
         pyleoclim.utils.tsutils.phaseran2 : phase randomization
         
         Examples
@@ -211,14 +213,21 @@ def from_param(self, param, length=50, time_pattern = 'even', settings=None):
         --------
 
         pyleoclim.utils.tsmodel.ar1_sim : AR(1) simulator
+
         pyleoclim.utils.tsmodel.colored_noise: simulating from a power law spectrum, $S(f) \propto f^{-\beta}$
+
         pyleoclim.utils.tsmodel.random_time_axis : Generate time increment vector according to a specific probability model
         
         Examples
         --------
-        ar1 = pyleo.SurrogateSeries(method='ar1sim', number=10) 
-        ar1.from_param(length=100, param = [2,2])
-        ar1.plot_envelope(title=rf'AR(1) synthetic series ($\tau={2},\sigma^2={2}$)')
+
+        .. jupyter-execute::
+
+            import pyleoclim as pyleo
+
+            ar1 = pyleo.SurrogateSeries(method='ar1sim', number=10)
+            ar1.from_param(length=100, param = [2,2])
+            ar1.plot_envelope(title=rf'AR(1) synthetic series ($\tau={2},\sigma^2={2}$)')
 
         '''    
         param = param if isinstance(param, list) else [param] # coerce param into a list, no matter the original format