-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update sdk docstrings for consistency of variables used #36
Labels
Comments
dpaiton
added
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
labels
Apr 12, 2024
We should also investigate standardizing when we use |
This was referenced Apr 30, 2024
We also occasionally use |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
We sometimes use equation letters for multiple purposes, which can lead to confusion. For example, in the docstring for
short::open::calculate_open_short
we say:p
is "spot price" or "price" nearly everywhere else; we shouldn't use it for the lp principal.We use
x
for generic "input variable" some times in the docs, but then elsewhere specifically mean "base amount". And when we say\Delta x
we always mean "change in base". We should avoid using it as a generic variable, and we should especially not use it to mean anything to do with "bonds".\Delta x
,\Delta y
,\Delta y_{\text{pool}}
,The text was updated successfully, but these errors were encountered: