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 example to readme docs #142

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Add example to readme docs #142

merged 2 commits into from
Sep 6, 2024

Conversation

charleskawczynski
Copy link
Member

@charleskawczynski charleskawczynski commented Nov 2, 2022

This PR updates the readme, and provides an example.

Closes #189.

@codecov
Copy link

codecov bot commented Nov 2, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.40%. Comparing base (ffbbe72) to head (98a80ed).
Report is 5 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@charleskawczynski charleskawczynski force-pushed the ck/readme_docs branch 3 times, most recently from 74564f7 to 936aede Compare February 14, 2024 14:12
@charleskawczynski charleskawczynski marked this pull request as ready for review February 14, 2024 14:12
@charleskawczynski charleskawczynski added documentation Improvements or additions to documentation Launch Buildkite Add label to launch Buildkite labels Feb 14, 2024
README.md Outdated Show resolved Hide resolved
@glwagner
Copy link
Member

glwagner commented 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.

@charleskawczynski
Copy link
Member Author

Thoughts on merging this and iterating? I think that this is an improvement.

README.md Show resolved Hide resolved
@charleskawczynski charleskawczynski added this pull request to the merge queue Sep 6, 2024
Merged via the queue into main with commit 638ae70 Sep 6, 2024
19 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Launch Buildkite Add label to launch Buildkite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More concise and descriptive "About"
3 participants