-
-
Notifications
You must be signed in to change notification settings - Fork 269
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
docs: fix incorrect light-client example #6297
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6297 +/- ##
=========================================
Coverage 80.38% 80.38%
=========================================
Files 202 202
Lines 19620 19620
Branches 1176 1176
=========================================
Hits 15771 15771
Misses 3821 3821
Partials 28 28 |
Performance Report✔️ no performance regression detected Full benchmark results
|
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.
Maybe we should run yarn check-readme
in CI along with tests to keep these readmes compile-able?
We actually do lodestar/.github/workflows/test.yml Lines 144 to 145 in 88744d8
But it doesn't seem to care at all ~/projects/ethereum/lodestar/packages/light-client [unstable ≡ +0 ~1 -0 !]> yarn check-readme
yarn run v1.22.19
$ typescript-docs-verifier
ℹ Compiling documentation TypeScript code snippets from README.md
ℹ Found 1 TypeScript snippets
✔ All snippets compiled OK @jeluard how did you verify and determine the changes to make it compile, just copy pasted it into a .ts file? |
@nflaig Yes, copy pasted. |
🎉 This PR is included in v1.15.0 🎉 |
Motivation
Make sure that the
light-client
example embedded in theREADME.md
file compiles.