DOC: attempt to fix docs for nearfield

lavakyan · Dec 12, 2021 · 2ce08b0 · 2ce08b0
1 parent 4bb0c7f
commit 2ce08b0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/doc/source/scripting/nearfield.rst b/doc/source/scripting/nearfield.rst
@@ -18,7 +18,7 @@ Incident beam with wavelength is 385 nm is directed by Z axis and have X polzari
 .. literalinclude:: mstm_nearfield.py
    :lines: 2-18
 
-Result image::
+Resulting image:
 
 .. image:: mstm_nearfield.png
 

diff --git a/mstm_studio/nearfield.py b/mstm_studio/nearfield.py
@@ -180,6 +180,9 @@ def write(self, filename):
                                                          self.field[i, j]))
 
     def plot(self):
+        '''
+        Show 2D field distribution
+        '''
         x, y = self._get_grid_hv()
         xx, yy = np.meshgrid(x, y)
         xx = np.transpose(xx)