-
Notifications
You must be signed in to change notification settings - Fork 602
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(front-matter): improve docs for stabilization #4789
docs(front-matter): improve docs for stabilization #4789
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4789 +/- ##
==========================================
- Coverage 92.36% 92.35% -0.01%
==========================================
Files 487 487
Lines 41539 41539
Branches 5405 5405
==========================================
- Hits 38366 38364 -2
- Misses 3117 3119 +2
Partials 56 56 ☔ 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.
Looking good! Few nits. Could you please also rebase? We just added support for checking class docs.
import { extract as extractJson } from "./json.ts"; | ||
import { extract as extractToml } from "./toml.ts"; | ||
import { extract as extractYaml } from "./yaml.ts"; | ||
|
||
export * from "./create_extractor.ts"; | ||
export * from "./test.ts"; | ||
|
||
export { extractJson, extractToml, extractYaml }; |
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.
For reviewers: it looks like exporting these is needed to get the links like {@linkcode extractJson | extract}
used in the module level doc to work correctly.
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.
Great work! Few suggestions. I realise we need tweak the Super Linter to check code snippets in non-@example
JSDocs. I'll do that then update this PR.
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
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.
Actually, I won't block this PR. LGMT!
This commit improves docs of the front-matter module.
Specifically, the following things are done:
@example
where appropriate to render the examples more beautifullycreateExtractor
function into smaller pieces so that each one has minimal yet meaningful example@returns
to thetest
functionFormat
type definitionFormat
typeTowards #3764