Fix D103: Missing docstring in public function

GenericMappingTools · Dec 27, 2023 · f22bfa0 · f22bfa0
1 parent d9116bd
commit f22bfa0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/examples/gallery/3d_plots/grdview_surface.py b/examples/gallery/3d_plots/grdview_surface.py
@@ -23,6 +23,9 @@
 # Define an interesting function of two variables, see:
 # https://en.wikipedia.org/wiki/Ackley_function
 def ackley(x, y):
+    """
+    Ackley function.
+    """
     return (
         -20 * np.exp(-0.2 * np.sqrt(0.5 * (x**2 + y**2)))
         - np.exp(0.5 * (np.cos(2 * np.pi * x) + np.cos(2 * np.pi * y)))

diff --git a/examples/tutorials/advanced/working_with_panel.py b/examples/tutorials/advanced/working_with_panel.py
@@ -73,9 +73,11 @@
 )
 
 
-# Define a function for plotting the single slices
 @pn.depends(central_lon=slider_lon)
 def view(central_lon):
+    """
+    Define a function for plotting the single slices.
+    """
     # Create a new instance or object of the pygmt.Figure() class
     fig = pygmt.Figure()
     fig.coast(
@@ -112,9 +114,11 @@ def view(central_lon):
 )
 
 
-# Define a function for plotting the single slices
 @pn.depends(central_lon=slider_lon)
 def view(central_lon):
+    """
+    Define a function for plotting the single slices.
+    """
     # Create a new instance or object of the pygmt.Figure() class
     fig = pygmt.Figure()
     # Set up a colormap for the elevation in meters