Skip to content

Commit

Permalink
Fix #92794. Promote comment options to stable
Browse files Browse the repository at this point in the history
  • Loading branch information
rebornix committed May 5, 2020
1 parent f25c779 commit 9be0faf
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 22 deletions.
20 changes: 20 additions & 0 deletions src/vs/vscode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10898,6 +10898,21 @@ declare module 'vscode' {
provideCommentingRanges(document: TextDocument, token: CancellationToken): ProviderResult<Range[]>;
}

/**
* Represents a [comment controller](#CommentController)'s [options](#CommentController.options).
*/
export interface CommentOptions {
/**
* An optional string to show on the comment input box when it's collapsed.
*/
prompt?: string;

/**
* An optional string to show as placeholder in the comment input box when it's focused.
*/
placeHolder?: string;
}

/**
* A comment controller is able to provide [comments](#CommentThread) support to the editor and
* provide users various ways to interact with comments.
Expand All @@ -10913,6 +10928,11 @@ declare module 'vscode' {
*/
readonly label: string;

/**
* Comment controller options
*/
options?: CommentOptions;

/**
* Optional commenting range provider. Provide a list [ranges](#Range) which support commenting to any given resource uri.
*
Expand Down
22 changes: 0 additions & 22 deletions src/vs/vscode.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2080,26 +2080,4 @@ declare module 'vscode' {
}

//#endregion

//#region Comment
export interface CommentOptions {
/**
* An optional string to show on the comment input box when it's collapsed.
*/
prompt?: string;

/**
* An optional string to show as placeholder in the comment input box when it's focused.
*/
placeHolder?: string;
}

export interface CommentController {
/**
* Comment controller options
*/
options?: CommentOptions;
}

//#endregion
}

0 comments on commit 9be0faf

Please sign in to comment.