From 6d23497d6f55c8e89ccbf0c9358dc383bd12723a Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Wed, 27 Dec 2023 21:22:23 -0500 Subject: [PATCH] Update task model docs (#3234) Dependencies are now implemented, and the docs should be clear about the format of the keys and values. Noticed while working on GothenburgBitFactory/tw.org#212. --- taskchampion/docs/src/tasks.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/taskchampion/docs/src/tasks.md b/taskchampion/docs/src/tasks.md index 6e9ebd034..bac90cc9d 100644 --- a/taskchampion/docs/src/tasks.md +++ b/taskchampion/docs/src/tasks.md @@ -38,10 +38,11 @@ The following keys, and key formats, are defined: * `modified` - the time of the last modification of this task * `start` - the most recent time at which this task was started (a task with no `start` key is not active) * `end` - if present, the time at which this task was completed or deleted (note that this key may not agree with `status`: it may be present for a pending task, or absent for a deleted or completed task) -* `tag_` - indicates this task has tag `` (value is an empty string) +* `tag_` - indicates this task has tag `` (value is ignored) * `wait` - indicates the time before which this task should be hidden, as it is not actionable * `entry` - the time at which the task was created -* `annotation_` - value is an annotation created at the given time +* `annotation_` - value is an annotation created at the given time; for example, `annotation_1693329505`. +* `dep_` - indicates this task depends on another task identified by ``; the value is ignored; for example, `dep_8c4fed9c-c0d2-40c2-936d-36fc44e084a0` Note that while TaskChampion recognizes "recurring" as a status, it does not implement recurrence directly.