docs(uuid): fix stale v1 JSDoc and remove unnecessary casts from examples - #7285
Open
tomas-zijdemans wants to merge 1 commit into
Open
docs(uuid): fix stale v1 JSDoc and remove unnecessary casts from examples#7285tomas-zijdemans wants to merge 1 commit into
tomas-zijdemans wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7285 +/- ##
==========================================
- Coverage 95.03% 95.03% -0.01%
==========================================
Files 617 618 +1
Lines 51637 51892 +255
Branches 9359 9408 +49
==========================================
+ Hits 49075 49316 +241
- Misses 2021 2030 +9
- Partials 541 546 +5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Fixes doc rot in
@std/uuidleft behind by an old API change. No code changes.v1.generate()used to returnstring | number[]. The union is long gone, but three traces of it survived:{@linkcode V1Options.*}references inv1.tspoint at an interface that was renamed toGenerateOptions, so the links render dead on JSR.@returnsdoc still says "a UUIDv1 string or an array of 16 bytes". It returns a string.mod.ts) castvalidate(uuid as string). The casts are no-ops now, and they teach readers to distrust a return type that is plainstring.All doc examples still compile and pass:
deno test --doc uuid/is green, 66 tests.I used Claude Code to help investigate and write this change.