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

Rewrote introduction of readme to be more targeted. #1099

Merged
merged 2 commits into from
Oct 4, 2023
Merged

Conversation

davidv1992
Copy link
Member

Closes #977

@codecov
Copy link

codecov bot commented Sep 28, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (406a7dc) 85.31% compared to head (d6ba501) 85.31%.
Report is 9 commits behind head on main.

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           

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@cikzh cikzh left a 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 Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 32 to 33
pollinterval: 16s, missing polls: 0
root dispersion: 0.000351s, root delay:0.003571s
Copy link
Contributor

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)

Copy link
Contributor

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Marlon Peeters <marlonp33@gmail.com>
Co-authored-by: Folkert de Vries <folkert@folkertdev.nl>
@davidv1992
Copy link
Member Author

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.

@davidv1992 davidv1992 requested review from cikzh and folkertdev October 4, 2023 11:37
@cikzh cikzh merged commit f89f958 into main Oct 4, 2023
16 checks passed
@cikzh cikzh deleted the update-readme branch October 4, 2023 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update repository readme.md
3 participants