foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-21 15:04:11 -05:00
Code Issues Packages 1 Wiki Activity

refactor(docs): use @experimental instead of @tags unstable (#23884)

Browse source
This commit is contained in:
Leo Kettmeir 2024-05-22 04:31:51 -07:00 committed by GitHub
parent fabd9a214b
commit 7ab7a14db7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 336 additions and 332 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

366
cli/tsc/dts/lib.deno.unstable.d.ts vendored
View file

File diff suppressed because it is too large Load diff

280
cli/tsc/dts/lib.deno_webgpu.d.ts vendored
View file

File diff suppressed because it is too large Load diff

6
ext/broadcast_channel/lib.deno_broadcast_channel.d.ts vendored
View file

@ -7,7 +7,7 @@
/** /**
* @category Messaging * @category Messaging
* @tags unstable * @experimental
*/ */
declare interface BroadcastChannelEventMap { declare interface BroadcastChannelEventMap {
"message": MessageEvent; "message": MessageEvent;
@ -16,7 +16,7 @@ declare interface BroadcastChannelEventMap {
/** /**
* @category Messaging * @category Messaging
* @tags unstable * @experimental
*/ */
declare interface BroadcastChannel extends EventTarget { declare interface BroadcastChannel extends EventTarget {
/** /**
@ -59,7 +59,7 @@ declare interface BroadcastChannel extends EventTarget {
/** /**
* @category Messaging * @category Messaging
* @tags unstable * @experimental
*/ */
declare var BroadcastChannel: { declare var BroadcastChannel: {
readonly prototype: BroadcastChannel; readonly prototype: BroadcastChannel;

6
tests/integration/lsp_tests.rs
View file

@ -1463,7 +1463,7 @@ fn lsp_hover_asset() {
"value": "interface Date", "value": "interface Date",
}, },
"Enables basic storage and retrieval of dates and times.", "Enables basic storage and retrieval of dates and times.",
"\n\n*@category* - Temporal \n\n*@tags* - unstable" "\n\n*@category* - Temporal \n\n*@experimental*"
], ],
"range": { "range": {
"start": { "line": 111, "character": 10, }, "start": { "line": 111, "character": 10, },
@ -2039,7 +2039,7 @@ fn lsp_hover_unstable_always_enabled() {
"value":"interface Deno.ForeignLibraryInterface" "value":"interface Deno.ForeignLibraryInterface"
}, },
"**UNSTABLE**: New API, yet to be vetted.\n\nA foreign library interface descriptor.", "**UNSTABLE**: New API, yet to be vetted.\n\nA foreign library interface descriptor.",
"\n\n*@category* - FFI \n\n*@tags* - unstable", "\n\n*@category* - FFI \n\n*@experimental*",
], ],
"range":{ "range":{
"start":{ "line":0, "character":14 }, "start":{ "line":0, "character":14 },
@ -2084,7 +2084,7 @@ fn lsp_hover_unstable_enabled() {
"value":"interface Deno.ForeignLibraryInterface" "value":"interface Deno.ForeignLibraryInterface"
}, },
"**UNSTABLE**: New API, yet to be vetted.\n\nA foreign library interface descriptor.", "**UNSTABLE**: New API, yet to be vetted.\n\nA foreign library interface descriptor.",
"\n\n*@category* - FFI \n\n*@tags* - unstable", "\n\n*@category* - FFI \n\n*@experimental*",
], ],
"range":{ "range":{
"start":{ "line":0, "character":14 }, "start":{ "line":0, "character":14 },

10
tools/jsdoc_checker.js
View file

@ -70,14 +70,8 @@ for (const file of project.getSourceFiles()) {
} }
if (unstableFiles.includes(file)) { if (unstableFiles.includes(file)) {
const tagsTag = tags.find((tag) => tag.getTagName() === "tags"); if (!tags.find((tag) => tag.getTagName() === "experimental")) {
if ( errors.push(getErrorPrefix(node) + "JSDoc @experimental tag");
!(tagsTag?.getComment() &&
tagsTag.getCommentText().includes("unstable"))
) {
errors.push(
getErrorPrefix(node) + "JSDoc @tags tag with value 'unstable'",
);
} }
} }
} }