docstring update

arfogg · Aug 23, 2024 · 71c5417 · 71c5417
1 parent 2d633ce
commit 71c5417
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/src/bivariate/calculate_return_periods_values.py b/src/bivariate/calculate_return_periods_values.py
@@ -25,9 +25,8 @@ def calculate_return_period(copula, sample_grid,
     ----------
     copula : copulas copula
         Copula that has been fit to some data
-    sample_grid : pd.DataFrame
-        Two columns with names same as copula, containing x and y values
-        to find the return period for.
+    sample_grid : np.array
+        Grid containing x and y values to find the return period for.
     block_size : pd.Timedelta, optional
         Size over which block maxima have been found. The default
         is pd.to_timedelta("365.2425D").