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.
This commit is contained in:
Dustin J. Mitchell 2023-12-27 21:22:23 -05:00 committed by GitHub
parent e29925155d
commit 6d23497d6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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_<tag>` - indicates this task has tag `<tag>` (value is an empty string)
* `tag_<tag>` - indicates this task has tag `<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_<timestamp>` - value is an annotation created at the given time
* `annotation_<timestamp>` - value is an annotation created at the given time; for example, `annotation_1693329505`.
* `dep_<uuid>` - indicates this task depends on another task identified by `<uuid>`; 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.