docs(front-matter): improve docs for stabilization #4789
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
magurotuna
changed the title
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. |
iuioiua
requested changes
May 21, 2024
magurotuna
commented
May 24, 2024
Comment on lines
+117
to
+124
| 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.
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.
iuioiua
requested changes
May 27, 2024
iuioiua
approved these changes
May 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit improves docs of the front-matter module.
Specifically, the following things are done:
@examplewhere appropriate to render the examples more beautifullycreateExtractorfunction into smaller pieces so that each one has minimal yet meaningful example@returnsto thetestfunctionFormattype definitionFormattypeTowards #3764