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.

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

Add examples for important functions/types #6

Open
samlaf opened this issue Aug 19, 2023 · 1 comment
Open

Add examples for important functions/types #6

samlaf opened this issue Aug 19, 2023 · 1 comment

Comments

@samlaf
Copy link
Collaborator

samlaf commented Aug 19, 2023

See https://go.dev/blog/examples

examples show up in godoc so will be very useful for helping avs teams understand our modules.

@samlaf
Copy link
Collaborator Author

samlaf commented Sep 24, 2023

Added the first example here. We should add more for the core functionalities as well. This is way better than having outdated code in READMEs because these godoc examples are forced to compile, so we have to update them when interfaces or structs change.

@shrimalmadhur shrimalmadhur transferred this issue from another repository Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant