chore: check class @example blocks in check_docs - #7339
Open
tomas-zijdemans wants to merge 1 commit into
Open
tomas-zijdemans wants to merge 1 commit into
tomas-zijdemans wants to merge 1 commit into
Conversation
assertClassDocs only called assertHasExampleTag when a class had no @example tag, so class examples never got the title or assertion-import checks. Call it unconditionally, and fix the four class docs that fail once it runs: - async/unstable_semaphore.ts: mark the Semaphore example no-assert - cli/unstable_progress_bar.ts: close the "Custom Formatting" code fence - internal/assertion_state.ts: mark the AssertionState example no-assert - streams/unstable_capped_delimiter_stream.ts: title the example "Usage"
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7339 +/- ##
========================================
Coverage 95.04% 95.04%
========================================
Files 619 618 -1
Lines 52012 51757 -255
Branches 9450 9401 -49
========================================
- Hits 49434 49192 -242
+ Misses 2031 2022 -9
+ Partials 547 543 -4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This branch has not been deployed
This file contains hidden or 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
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.
check_docs.tsnever validated@exampleblocks on classes.assertClassDocsonly calledassertHasExampleTagwhen the class had no@exampletag at all, so any class that did have one skipped the title check and the assertion-import check. Functions, methods and properties always got both. The guard came in with #6491.This PR calls
assertHasExampleTagunconditionally. That surfaced four class docs that fail, which I fixed here too:async/unstable_semaphore.ts: theSemaphoreexample has no assertion. I marked itno-assert, like every member example in the file.cli/unstable_progress_bar.ts: the "Custom Formatting" example was missing its closing fence, so the code block never ended. This one was a real rendering bug.internal/assertion_state.ts: theAssertionStateexample only constructs the object. I marked itno-assertto match its members.streams/unstable_capped_delimiter_stream.ts: the@examplehad no title, so it rendered as "Example 1". It's now "Usage".Testing:
deno task lint:docspasses. It reported 0 errors before the checker change and exactly these 4 with it.deno test --docon the four touched modules passes (19 tests).I used Claude Code to help investigate and write this change.