Skip to content

Commit fd8fc06

Browse files
committed
docs: Update example to show caller must save the markdown
Fixes #3287.
1 parent 0b56a68 commit fd8fc06

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/Advanced/Tasks Api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ const taskLine = '- [ ] This is a task 📅 2024-04-24';
9696

9797
const result = tasksApi.executeToggleTaskDoneCommand(taskLine, sourceFile.path);
9898

99+
// Do whatever you want with the returned value.
100+
// It's just a string containing the Markdown for the toggled task.
99101
console.log(result); // "- [x] This is a task 📅 2024-04-24 ✅ 2024-04-23"
100102
```
101103

0 commit comments

Comments
 (0)