Merge pull request #104 from northern-64bit/fix-option-controller-doc…

…string Fixes the docstrings of multiple functions in `options_controller.py`
JerBouma · Jan 22, 2024 · b863aa9 · b863aa9
2 parents e49efcf + 74a802b
commit b863aa9
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/financetoolkit/options/options_controller.py b/financetoolkit/options/options_controller.py
@@ -874,7 +874,7 @@ def get_dual_delta(
             rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
 
         Returns:
-            pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
+            pd.DataFrame: the dual delta values containing the tickers and strike prices as the index and the
             time to expiration as the columns.
 
         As an example:
@@ -1156,7 +1156,7 @@ def get_theta(
             rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
 
         Returns:
-            pd.DataFrame: the vega values containing the tickers and strike prices as the index and the
+            pd.DataFrame: the theta values containing the tickers and strike prices as the index and the
             time to expiration as the columns.
 
         As an example:
@@ -1301,7 +1301,7 @@ def get_rho(
             rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
 
         Returns:
-            pd.DataFrame: the vega values containing the tickers and strike prices as the index and the
+            pd.DataFrame: the rho values containing the tickers and strike prices as the index and the
             time to expiration as the columns.
 
         As an example:
@@ -1442,7 +1442,7 @@ def get_epsilon(
             rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
 
         Returns:
-            pd.DataFrame: the lambda values containing the tickers and strike prices as the index and the
+            pd.DataFrame: the epsilon values containing the tickers and strike prices as the index and the
             time to expiration as the columns.
 
         As an example:
@@ -2579,7 +2579,7 @@ def get_vera(
             rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
 
         Returns:
-            pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
+            pd.DataFrame: the vera values containing the tickers and strike prices as the index and the
             time to expiration as the columns.
 
         As an example:
@@ -3240,7 +3240,7 @@ def get_zomma(
             rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
 
         Returns:
-            pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
+            pd.DataFrame: the zomma values containing the tickers and strike prices as the index and the
             time to expiration as the columns.
 
         As an example:
@@ -3518,7 +3518,7 @@ def get_ultima(
             rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
 
         Returns:
-            pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
+            pd.DataFrame: the ultima values containing the tickers and strike prices as the index and the
             time to expiration as the columns.
 
         As an example: