-
Notifications
You must be signed in to change notification settings - Fork 19
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 testable examples #497
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Testable example are a great way to provide executable documentation for the code. They serve as both documentation and tests, demonstrating how to use the code in real-world scenarios.
The project has e2e tests which validate the behaviour of the components as a whole and can be used as an example to understand more about how the code is working. But it's still beneficial to include testable examples. because they focus on specific functionalities or APIs, providing focused and targeted documentation. They can complement e2e tests by offering developers quick and easy-to-understand examples of how to use individual components or functions.
https://go.dev/blog/examples
The text was updated successfully, but these errors were encountered: