Skip to content

Commit 1956763

Browse files
committed
docs: Document limitations of the API
1 parent e8db51e commit 1956763

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/Advanced/Tasks Api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,10 @@ This can be used, for example, to display the Auto-Suggest on non-task lines. [S
164164
> [!warning]
165165
> If the `Editor` is not a `MarkdownView`, the functionality is slightly limited.
166166
> It won't be possible to create [[Task Dependencies]] fields `id` and `dependsOn`.
167+
168+
## Limitations of the Tasks API
169+
170+
- Editing tasks:
171+
- It is not yet possible to use the API to edit an *existing task line* with Tasks [[Create or edit Task|Create or edit task UI]]. We are tracking this in [issue #1945](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/1945).
172+
- Searching tasks:
173+
- It is not yet possible to run Tasks searches via the API. We are tracking this in [issue #2459](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/2459).

docs/Support and Help/Known Limitations.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,7 @@ This page gathers together all the documentation on known limitations of the plu
106106
## Advanced: Urgency
107107

108108
![[Urgency#Limitations of the Urgency Score]]
109+
110+
## Advanced: Tasks API
111+
112+
![[Tasks Api#Limitations of the Tasks API]]

0 commit comments

Comments
 (0)