doc: Add docstring documentation

This commit is contained in:
Marty Oehme 2025-04-07 10:08:28 +02:00
parent 0f10789e9c
commit 0277f15ca2
Signed by: Marty
GPG key ID: 4E535BC19C61886E
2 changed files with 100 additions and 36 deletions

View file

@ -6,9 +6,11 @@ Focuses on letting you quickly:
- create notes for taskwarrior tasks
- edit notes for taskwarrior tasks
Does both by simply being invoked with `topen <task-id>`.
It does both by simply being invoked with `topen <task-id>`.
Automatically appends a small 'Note' annotation to your task so you know you already have notes for it.
Provide a taskwarrior task id or uuid and topen creates a new note file or lets
you edit an existing one. Additionally it adds a small annotation to the task
to let you see that there exists a note file next time you view the task.
Should just work as-is without additional configuration in most modern taskwarrior setups.[^moderntw]