Documentation: Add docstrings for interactive plotting

pyxem · May 6, 2024 · f3d9b95 · f3d9b95
1 parent 8b92dce
commit f3d9b95
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/diffsims/simulations/simulation2d.py b/diffsims/simulations/simulation2d.py
@@ -568,6 +568,9 @@ def plot(
             whether to include the direct beam in the plot
         ax : matplotlib Axes, optional
             axes on which to draw the pattern. If `None`, a new axis is created
+        interactive : bool, optional
+            Whether to add sliders for selecting the rotation and phase. This
+            is an experimental feature and will evolve/change in the future.
         **kwargs :
             passed to ax.scatter() method