-
Notifications
You must be signed in to change notification settings - Fork 632
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(toml): lint @std/toml
docs
#4799
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4799 +/- ##
=======================================
Coverage 92.36% 92.36%
=======================================
Files 488 488
Lines 41603 41603
Branches 5409 5409
=======================================
Hits 38425 38425
Misses 3122 3122
Partials 56 56 ☔ View full report in Codecov by Sentry. |
The docs for this module are still very lacking. Neither |
Oh, the lint should probably detect that? I got an error for missing |
Yes, I agree it should. See comment at the top of |
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.
Can you please add Ignore - I see we've moved this all into the doc checker now.toml/mod.ts
to the file list in the lint:docs
task?
* @param srcObj | ||
* | ||
* @example Stringify an object | ||
* ```ts |
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.
Can you please use an assertion from std/assert
here? It ensures the example is correct. Ditto for other examples.
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.
Added the assertions
Co-authored-by: Asher Gomez <[email protected]>
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.
LGTM
No description provided.