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): improve unstable API notices #5482

Merged
merged 1 commit into from
Jul 19, 2024
Merged

docs(cli): improve unstable API notices #5482

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
15 changes: 9 additions & 6 deletions cli/spinner.ts
View file
Open in desktop
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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this doesn't look the best when hovered-on in VSCode, but I think that's fixable, and a nit, compared to how prominent these notices are in JSR.

image

*
* @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