Skip to content

Commit b863aa9

Browse files
authored
Merge pull request #104 from northern-64bit/fix-option-controller-docstring
Fixes the docstrings of multiple functions in `options_controller.py`
2 parents e49efcf + 74a802b commit b863aa9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

financetoolkit/options/options_controller.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -874,7 +874,7 @@ def get_dual_delta(
874874
rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
875875
876876
Returns:
877-
pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
877+
pd.DataFrame: the dual delta values containing the tickers and strike prices as the index and the
878878
time to expiration as the columns.
879879
880880
As an example:
@@ -1156,7 +1156,7 @@ def get_theta(
11561156
rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
11571157
11581158
Returns:
1159-
pd.DataFrame: the vega values containing the tickers and strike prices as the index and the
1159+
pd.DataFrame: the theta values containing the tickers and strike prices as the index and the
11601160
time to expiration as the columns.
11611161
11621162
As an example:
@@ -1301,7 +1301,7 @@ def get_rho(
13011301
rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
13021302
13031303
Returns:
1304-
pd.DataFrame: the vega values containing the tickers and strike prices as the index and the
1304+
pd.DataFrame: the rho values containing the tickers and strike prices as the index and the
13051305
time to expiration as the columns.
13061306
13071307
As an example:
@@ -1442,7 +1442,7 @@ def get_epsilon(
14421442
rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
14431443
14441444
Returns:
1445-
pd.DataFrame: the lambda values containing the tickers and strike prices as the index and the
1445+
pd.DataFrame: the epsilon values containing the tickers and strike prices as the index and the
14461446
time to expiration as the columns.
14471447
14481448
As an example:
@@ -2579,7 +2579,7 @@ def get_vera(
25792579
rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
25802580
25812581
Returns:
2582-
pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
2582+
pd.DataFrame: the vera values containing the tickers and strike prices as the index and the
25832583
time to expiration as the columns.
25842584
25852585
As an example:
@@ -3240,7 +3240,7 @@ def get_zomma(
32403240
rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
32413241
32423242
Returns:
3243-
pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
3243+
pd.DataFrame: the zomma values containing the tickers and strike prices as the index and the
32443244
time to expiration as the columns.
32453245
32463246
As an example:
@@ -3518,7 +3518,7 @@ def get_ultima(
35183518
rounding (int | None, optional): The number of decimals to round the results to. Defaults to 4.
35193519
35203520
Returns:
3521-
pd.DataFrame: the gamma values containing the tickers and strike prices as the index and the
3521+
pd.DataFrame: the ultima values containing the tickers and strike prices as the index and the
35223522
time to expiration as the columns.
35233523
35243524
As an example:

0 commit comments

Comments
 (0)