Improve docstring of NLLGrid.plot_slice method

claudiodsf · Sep 27, 2024 · 63c247a · 63c247a
1 parent 1ba686d
commit 63c247a
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/nllgrid/NLLGrid.py b/nllgrid/NLLGrid.py
@@ -1220,8 +1220,10 @@ def plot(self, slice_index=None, handle=False, figure=None, ax_xy=None,
 
         Parameters
         ----------
-        slice_index : int, optional
-            Index of the slice to plot. The default is None.
+        slice_index : int or str, optional
+            Index of the slice to plot. Use 'max' or 'min' to plot the slice
+            at the grid's maximum or minimum value, respectively.
+            The default is None.
         handle : bool, optional
             Whether to return the handle of the plot. The default is False.
         figure : object, optional