Skip to content

OffsetHelper method signatures documented in the README are out of date #27

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
Closed
danceratopz opened this issue Jun 14, 2022 · 0 comments · Fixed by #29
Closed

OffsetHelper method signatures documented in the README are out of date #27

danceratopz opened this issue Jun 14, 2022 · 0 comments · Fixed by #29

Comments

@danceratopz
Copy link
Contributor

The OffsetHelper autoOffset* methods that are documented in the README are out of date with those defined in the contract.

Perhaps a better approach would be to remove the documentation from the README and generate some nice documentation from the contract's natspec comments using solidity-docgen.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs: Improve readme and autogenerate natspec doc danceratopz/toucan-example-implementations
1 participant
@danceratopz