-
Notifications
You must be signed in to change notification settings - Fork 4
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 example to readme docs #142
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #142 +/- ##
==========================================
- Coverage 90.93% 90.40% -0.53%
==========================================
Files 10 9 -1
Lines 1180 1167 -13
==========================================
- Hits 1073 1055 -18
- Misses 107 112 +5 ☔ View full report in Codecov by Sentry. |
74564f7
to
936aede
Compare
It might be nice for clarity to show what the parameters are in this example, or at least give an example of inspecting the struct to find the parameters (since they cannot be determined by reading the code). We should also show users how to change the parameters. |
03eb6c9
to
85b4f6c
Compare
Thoughts on merging this and iterating? I think that this is an improvement. |
This PR updates the readme, and provides an example.
Closes #189.