chore: improve doc checker #4782
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4782 +/- ##
==========================================
- Coverage 91.88% 91.88% -0.01%
==========================================
Files 486 486
Lines 41340 41339 -1
Branches 5325 5325
==========================================
- Hits 37987 37986 -1
Misses 3296 3296
Partials 57 57 ☔ View full report in Codecov by Sentry. |
iuioiua
commented
May 21, 2024
| @@ -19,7 +19,7 @@ | |||
| "lint:circular": "deno run --allow-env --allow-read --allow-net=deno.land,jsr.io ./_tools/check_circular_package_dependencies.ts", | |||
| "lint:mod-exports": "deno run --allow-env --allow-read ./_tools/check_mod_exports.ts", | |||
| "lint:tools-types": "deno check _tools/*.ts", | |||
| "lint:docs": "deno run -A _tools/check_docs.ts && deno doc --lint collections/mod.ts bytes/mod.ts datetime/mod.ts internal/mod.ts media_types/mod.ts url/mod.ts", | |||
| "lint:docs": "deno doc --lint collections/mod.ts bytes/mod.ts datetime/mod.ts internal/mod.ts media_types/mod.ts url/mod.ts && deno run -A _tools/check_docs.ts", | |||
There was a problem hiding this comment.
By swapping the order of commands, we know that document.jsDoc is defined.
|
On second thought, do we want to check that even variables have examples? |
hmm, I don't think every variable needs examples.. |
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 PR:
lint:docstask sodocument.jsDocis known to be defined in the doc checker.document.