Skip to content

Remove 'experimental' notice from API docs #828

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

Merged
merged 1 commit into from
Nov 15, 2020
Merged

Remove 'experimental' notice from API docs #828

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
8 changes: 0 additions & 8 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,6 @@ if (result.status !== ResultStatus.Succeeded) {

## Standalone Lint Conversion API

> ⚠ This area of code is still considered experimental.
> Use at your own risk.
> Please file an issue on GitHub if you'd like to see changes.

Portions of the individual lint conversion steps within `convertTSLintConfig` are each available as exported functions as well.

* **[`findOriginalConfigurations`](#findOriginalConfigurations)** takes in an object of original configuration locations and retrieves their raw and computed contents.
Expand Down Expand Up @@ -139,10 +135,6 @@ const formatted = formatOutput("eslintrc.js", raw);

## Standalone Comment Conversion API

> ⚠ This area of code is still considered experimental.
> Use at your own risk.
> Please file an issue on GitHub if you'd like to see changes.

The individual per-file conversion logic within `convertComments` is available as a standalone function:

### `convertFileComments`
Expand Down