Skip to content

Commit 443eafe

Browse files
committed
Remove dashes from JSDoc
1 parent 737fa11 commit 443eafe

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

extensions/ql-vscode/src/helpers.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ export function withProgress<R>(
4646
/**
4747
* Show an error message and log it to the console
4848
*
49-
* @param message The message to show.
50-
* @param items A set of items that will be rendered as actions in the message.
49+
* @param message The message to show.
50+
* @param items A set of items that will be rendered as actions in the message.
5151
*
52-
* @return A thenable that resolves to the selected item or undefined when being dismissed.
52+
* @return A thenable that resolves to the selected item or undefined when being dismissed.
5353
*/
5454
export function showAndLogErrorMessage(message: string, ...items: string[]): Thenable<string | undefined> {
5555
logger.log(message);
@@ -58,10 +58,10 @@ export function showAndLogErrorMessage(message: string, ...items: string[]): The
5858
/**
5959
* Show a warning message and log it to the console
6060
*
61-
* @param message The message to show.
62-
* @param items A set of items that will be rendered as actions in the message.
61+
* @param message The message to show.
62+
* @param items A set of items that will be rendered as actions in the message.
6363
*
64-
* @return A thenable that resolves to the selected item or undefined when being dismissed.
64+
* @return A thenable that resolves to the selected item or undefined when being dismissed.
6565
*/
6666
export function showAndLogWarningMessage(message: string, ...items: string[]): Thenable<string | undefined> {
6767
logger.log(message);
@@ -70,10 +70,10 @@ export function showAndLogWarningMessage(message: string, ...items: string[]): T
7070
/**
7171
* Show an information message and log it to the console
7272
*
73-
* @param message The message to show.
74-
* @param items A set of items that will be rendered as actions in the message.
73+
* @param message The message to show.
74+
* @param items A set of items that will be rendered as actions in the message.
7575
*
76-
* @return A thenable that resolves to the selected item or undefined when being dismissed.
76+
* @return A thenable that resolves to the selected item or undefined when being dismissed.
7777
*/
7878
export function showAndLogInformationMessage(message: string, ...items: string[]): Thenable<string | undefined> {
7979
logger.log(message);
@@ -82,9 +82,9 @@ export function showAndLogInformationMessage(message: string, ...items: string[]
8282

8383
/**
8484
* Opens a modal dialog for the user to make a yes/no choice.
85-
* @param message The message to show.
85+
* @param message The message to show.
8686
*
87-
* @return `true` if the user clicks 'Yes', `false` if the user clicks 'No' or cancels the dialog.
87+
* @return `true` if the user clicks 'Yes', `false` if the user clicks 'No' or cancels the dialog.
8888
*/
8989
export async function showBinaryChoiceDialog(message: string): Promise<boolean> {
9090
const yesItem = { title: 'Yes', isCloseAffordance: false };
@@ -95,10 +95,10 @@ export async function showBinaryChoiceDialog(message: string): Promise<boolean>
9595

9696
/**
9797
* Show an information message with a customisable action.
98-
* @param message The message to show.
99-
* @param actionMessage - The call to action message.
98+
* @param message The message to show.
99+
* @param actionMessage The call to action message.
100100
*
101-
* @return `true` if the user clicks the action, `false` if the user cancels the dialog.
101+
* @return `true` if the user clicks the action, `false` if the user cancels the dialog.
102102
*/
103103
export async function showInformationMessageWithAction(message: string, actionMessage: string): Promise<boolean> {
104104
const actionItem = { title: actionMessage, isCloseAffordance: false };

0 commit comments

Comments
 (0)