Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Commit

Permalink
Fixing docstrings for calc close functions (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
slundqui authored Mar 1, 2024
1 parent 6d79238 commit 12c2b57
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions crates/hyperdrivepy/python/hyperdrivepy/hyperdrive_state.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ def calculate_close_long(
bond_amount: str (FixedPoint)
The amount of bonds to sell.
normalized_time_remaining: str (FixedPoint)
The time remaining before the long reaches maturity, normalized such that 0 is at opening and 1 is at maturity.
The time remaining before the long reaches maturity, normalized such that 1 is at opening and 0 is at maturity.
Returns
-------
Expand Down Expand Up @@ -245,7 +245,7 @@ def calculate_close_short(
close_vault_share_price: str (FixedPoint)
The share price when the short was closed.
normalized_time_remaining: str (FixedPoint)
The time remaining before the short reaches maturity, normalized such that 0 is at opening and 1 is at maturity.
The time remaining before the short reaches maturity, normalized such that 1 is at opening and 0 is at maturity.
Returns
-------
Expand Down

0 comments on commit 12c2b57

Please sign in to comment.