-
-
Notifications
You must be signed in to change notification settings - Fork 44
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
Rewrote introduction of readme to be more targeted. #1099
Conversation
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1099 +/- ##
=======================================
Coverage 85.31% 85.31%
=======================================
Files 54 54
Lines 14725 14729 +4
=======================================
+ Hits 12562 12566 +4
Misses 2163 2163 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README is now indeed much better targeted, but I think the link to the documentation website should be more prominent
README.md
Outdated
pollinterval: 16s, missing polls: 0 | ||
root dispersion: 0.000351s, root delay:0.003571s |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it it's "root dispersion" then should it not also be "poll interval"? (i know that is not in this PR but I'm noticing it now)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
made this change in #1101
Co-authored-by: Marlon Peeters <marlonp33@gmail.com> Co-authored-by: Folkert de Vries <folkert@folkertdev.nl>
Taken the suggestions from @cikzh, and added the spaces between poll and interval. Suggest we make a decision on a badge for the documentation in a separate PR. |
Closes #977