Skip to content
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.

Sign up for GitHub

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

Jump to bottom

ethpy: improve hyperdrive api documentation #1070

Closed
dpaiton opened this issue Nov 8, 2023 · 0 comments · Fixed by #1074
Closed

ethpy: improve hyperdrive api documentation #1070

dpaiton opened this issue Nov 8, 2023 · 0 comments · Fixed by #1074
Assignees
@dpaiton
Labels
documentation bug or request for docs enhancement A feature or refactor request

Comments

@dpaiton
Copy link
Member

dpaiton commented Nov 8, 2023 •
edited
Loading

calc_max_short returns the amount in bonds, but the docs are inconsistent:

The pyperdrive docs correctly say this:
https://github.com/delvtech/pyperdrive/blob/main/crates/pyperdrive/python/pyperdrive/hyperdrive_state.py#L210

but the elf-sims docs don't:
https://github.com/delvtech/elf-simulations/blob/main/lib/ethpy/ethpy/hyperdrive/api/api.py#L840

We need to audit the hyperdrive api documentation and fix discrepancies like this.
@dpaiton dpaiton self-assigned this Nov 8, 2023
@dpaiton dpaiton added enhancement A feature or refactor request documentation bug or request for docs labels Nov 8, 2023
@dpaiton dpaiton linked a pull request Nov 8, 2023 that will close this issue
Fix Hyperdrive API docstrings #1074
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dpaiton dpaiton

Labels
documentation bug or request for docs enhancement A feature or refactor request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix Hyperdrive API docstrings delvtech/agent0
1 participant
@dpaiton