Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli,encoding,fmt,jsonc,path,semver,testing,text,toml,url): remove "This module is browser compatible" note #4945

Merged
merged 1 commit into from
Jun 4, 2024
Merged

docs(cli,encoding,fmt,jsonc,path,semver,testing,text,toml,url): remove "This module is browser compatible" note #4945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions cli/parse_args.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
* Command line arguments parser based on
* {@link https://github.com/minimistjs/minimist | minimist}.
*
* This module is browser compatible.
*
* @example
* ```ts
* import { parseArgs } from "@std/cli/parse-args";
Expand Down
2 changes: 0 additions & 2 deletions encoding/ascii85.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
/**
* Utilities for working with {@link https://en.wikipedia.org/wiki/Ascii85 | ascii85} encoding.
*
* This module is browser compatible.
*
* ## Specifying a standard and delimiter
*
* By default, all functions are using the most popular Adobe version of ascii85
Expand Down
2 changes: 0 additions & 2 deletions encoding/base32.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
*
* Modified from {@link https://github.com/beatgammit/base64-js}.
*
* This module is browser compatible.
*
* ```ts
* import { encodeBase32, decodeBase32 } from "@std/encoding/base32";
* import { assertEquals } from "@std/assert/assert-equals";
Expand Down
2 changes: 0 additions & 2 deletions encoding/base58.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
* {@link https://datatracker.ietf.org/doc/html/draft-msporny-base58-03 | base58}
* encoding and decoding.
*
* This module is browser compatible.
*
* ```ts
* import { encodeBase58, decodeBase58 } from "@std/encoding/base58";
* import { assertEquals } from "@std/assert/assert-equals";
Expand Down
2 changes: 0 additions & 2 deletions encoding/base64.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
* {@link https://www.rfc-editor.org/rfc/rfc4648.html#section-4 | base64}
* encoding and decoding.
*
* This module is browser compatible.
*
* ```ts
* import {
* encodeBase64,
Expand Down
2 changes: 0 additions & 2 deletions encoding/base64url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
* {@link https://www.rfc-editor.org/rfc/rfc4648.html#section-5 | base64url}
* encoding and decoding.
*
* This module is browser compatible.
*
* @module
*/

Expand Down
2 changes: 0 additions & 2 deletions encoding/hex.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
* {@link https://github.com/golang/go/blob/go1.12.5/src/encoding/hex/hex.go | encoding/hex}
* library.
*
* This module is browser compatible.
*
* ```ts
* import {
* decodeHex,
Expand Down
2 changes: 0 additions & 2 deletions encoding/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
/**
* Utilities for encoding and decoding common formats like hex, base64, and varint.
*
* This module is browser compatible.
*
* ```ts
* import { encodeBase64, decodeBase64 } from "@std/encoding";
* import { assertEquals } from "@std/assert/assert-equals";
Expand Down
2 changes: 0 additions & 2 deletions fmt/bytes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ export interface FormatOptions {
* Based on {@link https://github.com/sindresorhus/pretty-bytes | pretty-bytes}.
* A utility for displaying file sizes for humans.
*
* This module is browser compatible.
*
* @param num The bytes value to format
* @param options The options for formatting
* @returns The formatted string
Expand Down
2 changes: 0 additions & 2 deletions fmt/colors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
/**
* String formatters and utilities for dealing with ANSI color codes.
*
* This module is browser compatible.
*
* This module supports `NO_COLOR` environmental variable disabling any coloring
* if `NO_COLOR` is set.
*
Expand Down
2 changes: 0 additions & 2 deletions jsonc/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
* module only provides a means of parsing JSONC. JSONC serialization is not
* yet supported.
*
* This module is browser compatible.
*
* ```ts
* import { parse } from "@std/jsonc";
* import { assertEquals } from "@std/assert/assert-equals";
Expand Down
2 changes: 0 additions & 2 deletions jsonc/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
* {@link https://code.visualstudio.com/docs/languages/json#_json-with-comments | JSONC}
* (JSON with Comments) strings.
*
* This module is browser compatible.
*
* @module
*/

Expand Down
2 changes: 0 additions & 2 deletions path/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
* assertEquals(fromFileUrl("file:///home/foo"), "\\home\\foo");
* ```
*
* This module is browser compatible.
*
* @module
*/

Expand Down
2 changes: 0 additions & 2 deletions path/posix/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
* assertEquals(fromFileUrl("file:///home/foo"), "/home/foo");
* ```
*
* This module is browser compatible.
*
* @module
*/
export * from "./basename.ts";
Expand Down
2 changes: 0 additions & 2 deletions path/windows/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
* assertEquals(fromFileUrl("file:///home/foo"), "\\home\\foo");
* ```
*
* This module is browser compatible.
*
* @module
*/
export * from "./basename.ts";
Expand Down
2 changes: 1 addition & 1 deletion semver/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@
* If you want to know if a version satisfies or does not satisfy a range, use the
* {@linkcode satisfies} function.
*
* This module is browser compatible.
*
*

*
Expand Down
2 changes: 0 additions & 2 deletions testing/mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,6 @@
* });
* ```
*
* This module is browser compatible.
*
* @module
*/

Expand Down
2 changes: 0 additions & 2 deletions text/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@
* assertEquals(words.sort(compareSimilarity("hep")), ["help", "hi", "hello"]);
* ```
*
* This module is browser compatible.
*
* @module
*/

Expand Down
2 changes: 0 additions & 2 deletions toml/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@
* }
* ```
*
* This module is browser compatible.
*
* ```ts
* import { parse, stringify } from "@std/toml";
* import { assertEquals } from "@std/assert/assert-equals";
Expand Down
2 changes: 0 additions & 2 deletions url/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
* Utilities for working with
* {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/URL | URL}s.
*
* This module is browser compatible.
*
* ## Get basename
*
* {@linkcode basename} returns the base name of a URL or URL string, optionally
Expand Down