Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-21 20:50:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs(streams): rest arguments not being asserted in docs (#6155)

Browse Source
This commit is contained in:
Efe 2024-10-29 06:24:18 +01:00 committed by GitHub
parent 2835dccdd0
commit ff6037adf7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
_tools/check_docs.ts
View File

@ -307,6 +307,9 @@ function assertFunctionDocs(
if (param.kind === "identifier") { if (param.kind === "identifier") {
assertHasParamTag(document, param.name); assertHasParamTag(document, param.name);
} }
if (param.kind === "rest" && param.arg.kind === "identifier") {
assertHasParamTag(document, param.arg.name);
}
if (param.kind === "assign" && param.left.kind === "identifier") { if (param.kind === "assign" && param.left.kind === "identifier") {
assertHasParamTag(document, param.left.name); assertHasParamTag(document, param.left.name);
} }

1
streams/early_zip_readable_streams.ts
View File

@ -12,6 +12,7 @@
* even after one of them ends, use {@linkcode zipReadableStreams}. * even after one of them ends, use {@linkcode zipReadableStreams}.
* *
* @typeparam T The type of the chunks in the input streams. * @typeparam T The type of the chunks in the input streams.
* @param streams An iterable of `ReadableStream`s to merge.
* @returns A `ReadableStream` that will emit the zipped chunks * @returns A `ReadableStream` that will emit the zipped chunks
* *
* @example Zip 2 streams with the same length * @example Zip 2 streams with the same length

1
streams/zip_readable_streams.ts
View File

@ -11,6 +11,7 @@
* the other streams when one of them ends, use {@linkcode earlyZipReadableStreams}. * the other streams when one of them ends, use {@linkcode earlyZipReadableStreams}.
* *
* @typeparam T The type of the chunks in the input/output streams. * @typeparam T The type of the chunks in the input/output streams.
* @param streams An iterable of `ReadableStream`s to merge.
* @returns A `ReadableStream` that will emit the zipped chunks. * @returns A `ReadableStream` that will emit the zipped chunks.
* *
* @example Zip 2 streams with the same length * @example Zip 2 streams with the same length