Skip to content

Commit 9515340

Browse files
committed
jsdoc: Make the TasksApiV1.ts consistent with docs/Advanced/Tasks Api.md
This is the opposite of what #3565 was offering to do. See my comments there.
1 parent aac4a3b commit 9515340

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/Api/TasksApiV1.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ export interface TasksApiV1 {
1111
createTaskLineModal(): Promise<string>;
1212

1313
/**
14-
* Opens the Tasks UI and returns the Markdown string for the edited
15-
* task line. Does not edit the task line in the file.
14+
* Opens the Tasks UI pre-filled with the provided task line for editing.
15+
* Does not edit the task line in the file, but returns the edited task line as a Markdown string.
1616
*
17-
* @returns {Promise<string>} A promise that contains the Markdown string for the task edited or
18-
* an empty string, if data entry was cancelled.
17+
* @param taskLine The markdown string of the task line to edit
18+
* @returns {Promise<string>} A promise that contains the Markdown string for the edited task or
19+
* an empty string in the case where the data entry was cancelled.
1920
*/
2021
editTaskLineModal(taskLine: string): Promise<string>;
2122

0 commit comments

Comments
 (0)