Add example to readme docs #142
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #142 +/- ##
=======================================
Coverage 93.04% 93.04%
=======================================
Files 10 10
Lines 1150 1150
=======================================
Hits 1070 1070
Misses 80 80 ☔ View full report in Codecov by Sentry. |
charleskawczynski
force-pushed
the
ck/readme_docs
branch
2 times, most recently
from
5bcbf61
to
74564f7
Compare
charleskawczynski
force-pushed
the
ck/readme_docs
branch
from
74564f7
to
936aede
Compare
charleskawczynski
added
documentation
glwagner
reviewed
Feb 14, 2024
|
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. |
Co-authored-by: Gregory L. Wagner <wagner.greg@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the readme, and provides an example.
Closes #189.