WIP: document the adaptive methods

src/pypfilt/__init__.py

@@ -385,6 +385,8 @@ def forecast(ctx, times, filename):
     return results
 
 
+# TODO: link to the pypfilt.adaptive methods, which should document the
+# required parameters.
 def adaptive_fit(ctx, filename, save_when=None, save_to=None):
     """
     Run a series of adaptive fits over all observations.

src/pypfilt/adaptive.py

@@ -28,6 +28,7 @@ def _simulation_period(ctx):
     return (start, until)
 
 
+# TODO: document the required parameters!
 def fit_effective_fraction(ctx, start, until):
     """
     Return a series of fits where each pass tunes the observation models to
@@ -179,6 +180,7 @@ def fit_effective_fraction(ctx, start, until):
     return fits
 
 
+# TODO: document the required parameters!
 def fixed_exponents(ctx, start, until):
     """
     Return a series of fits where the likelihoods are raised to a fixed