Add docstring description

edwardoughton · Mar 16, 2020 · 0d800b6 · 0d800b6
1 parent 6b01c5c
commit 0d800b6
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/itmlogic/qlrpfl.py b/src/itmlogic/qlrpfl.py
@@ -8,6 +8,16 @@ def qlrpfl(prop):
     """
     Preparatory subroutine for point-to-point mode.
 
+    Parameters
+    ----------
+    prop : dict
+        Contains all input propagation parameters.
+
+    Returns
+    -------
+    prop : dict
+        Contains all input and output propagation parameters.
+
     """
     prop['dist'] = prop['pfl'][0] * prop['pfl'][1]