finished docstring for backtr function

added return behavior to the docstring
achandlr · Apr 7, 2020 · 4b29b09 · 4b29b09
1 parent b9384c8
commit 4b29b09
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/geostatspy/geostats.py b/geostatspy/geostats.py
@@ -36,7 +36,8 @@ def backtr(df,vcol,vr,vrg,zmin,zmax,ltail,ltpar,utail,utpar):
     :param ltpar: lower tail extrapolation parameter
     :param utail: upper tail value
     :param utpar: upper tail extrapolation parameter
-    :return: TODO
+    :return: backtr: the DataFrame column, which has been back transformed using
+             the provided transformation table and tail extrapolation.
     """    
 
     EPSLON=1.0e-20