docs(async): improve docs for stabilization #4803
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4803 +/- ##
==========================================
- Coverage 91.94% 91.50% -0.44%
==========================================
Files 486 486
Lines 41327 41329 +2
Branches 5321 5284 -37
==========================================
- Hits 37998 37820 -178
- Misses 3272 3450 +178
- Partials 57 59 +2 ☔ View full report in Codecov by Sentry. |
| * @typeParam T The type of the provided and returned promise. | ||
| * @param p The promise to make abortable. | ||
| * @param signal The signal to abort the promise with. | ||
| * @returns A promise that can be aborted. | ||
| * | ||
| * @example |
There was a problem hiding this comment.
Nit: It would've been nice to have a snippet title to avoid having it as "Example 1" in JSR. Ditto for other @example code snippets.
There was a problem hiding this comment.
i feel like if its a single example, it being Example 1 is fine. most scenarios have only really one example that makes sense to have, and describing it will seem a bit too much. though definitively should be enforced for multiple examples
There was a problem hiding this comment.
We've now added example titles to the list of checks for the doc checker. Please feel free to review #4841.
No description provided.