Skip to content

Commit

Permalink
docs(cli): improve unstable API notices (#5482)
Browse files Browse the repository at this point in the history
  • Loading branch information
iuioiua authored Jul 19, 2024
1 parent 00645f0 commit a6b1633
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions cli/spinner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ const DEFAULT_SPINNER = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧",
export type Ansi = string & {};

/**
* **UNSTABLE**: New API, yet to be vetted.
*
* Color options for {@linkcode SpinnerOptions.color}.
*
* > [!WARNING]
* > **UNSTABLE**: New API, yet to be vetted.
*
* @experimental
*/
export type Color =
Expand Down Expand Up @@ -50,10 +51,11 @@ const COLORS: Record<Color, string> = {
};

/**
* **UNSTABLE**: New API, yet to be vetted.
*
* Options for {@linkcode Spinner}.
*
* > [!WARNING]
* > **UNSTABLE**: New API, yet to be vetted.
*
* @experimental
*/
export interface SpinnerOptions {
Expand Down Expand Up @@ -82,10 +84,11 @@ export interface SpinnerOptions {
}

/**
* **UNSTABLE**: New API, yet to be vetted.
*
* A spinner that can be used to indicate that something is loading.
*
* > [!WARNING]
* > **UNSTABLE**: New API, yet to be vetted.
*
* @example Usage
* ```ts no-eval
* import { Spinner } from "@std/cli/spinner";
Expand Down

0 comments on commit a6b1633

Please sign in to comment.