update register_webview_plot documentation

reflectometry · Oct 3, 2024 · 7957b85 · 7957b85
1 parent f3c1c7e
commit 7957b85
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/refl1d/experiment.py b/refl1d/experiment.py
@@ -340,8 +340,10 @@ def save_refl(self, basename):
     def register_webview_plot(
         self, plot_title: str, plot_function: WebviewPlotFunction, change_with: Literal["parameter", "uncertainty"]
     ):
-        # Plot function syntax: f(model, problem, state)
         # change_with = 'parameter' or 'uncertainty'
+        # Plot function syntax: f(model, problem) for 'parameter'
+        #                       f(model, problem, state, n_samples) for 'uncertainty'
+
         self._webview_plots[plot_title] = dict(change_with=change_with, func=plot_function)
 
     @property