update docs

Author: andrewinci

doc/obsidian.txt

@@ -135,6 +135,8 @@ COMMANDS                                                   *obsidian-commands*
     command has one optional argument: the title of the new note.
 - `:Obsidian toc` to load the table of contents of the current note into a picker
     list.
+- `:Obsidian tasks [STATUS]` to load the list of tasks of the current vault into
+    a picker list.
 
 
 DEMO                                                           *obsidian-demo*
@@ -580,12 +582,12 @@ carefully and customize it to your needs:
         max_file_length = 5000,  -- disable UI features for files with more than this many lines
         -- Define how various check-boxes are displayed
         checkboxes = {
-          -- NOTE: the 'char' value has to be a single character, and the highlight groups are defined below.
-          [" "] = { char = "󰄱", hl_group = "ObsidianTodo" },
-          ["x"] = { char = "", hl_group = "ObsidianDone" },
-          [">"] = { char = "", hl_group = "ObsidianRightArrow" },
-          ["~"] = { char = "󰰱", hl_group = "ObsidianTilde" },
-          ["!"] = { char = "", hl_group = "ObsidianImportant" },
+          -- NOTE: the 'char' value and the status has to be a single character, and the highlight groups are defined below.
+          [" "] = { char = "󰄱", order = 1, name = "todo", hl_group = "ObsidianTodo" },
+          ["x"] = { char = "", order = 2, name = "done", hl_group = "ObsidianDone" },
+          [">"] = { char = "", order = 3, name = "doing", hl_group = "ObsidianRightArrow" },
+          ["~"] = { char = "󰰱", order = 4, name = "cancelled", hl_group = "ObsidianTilde" },
+          ["!"] = { char = "", order = 5, name = "important", hl_group = "ObsidianImportant" },
           -- Replace the above with this if you don't have a patched font:
           -- [" "] = { char = "☐", hl_group = "ObsidianTodo" },
           -- ["x"] = { char = "✔", hl_group = "ObsidianDone" },

doc/obsidian_api.txt

@@ -665,6 +665,29 @@ Parameters ~
 Return ~
 `(obsidian.Picker| `(optional))``
 
+------------------------------------------------------------------------------
+Class ~
+{obsidian.Task}
+
+Fields ~
+{path} `(string)` The path to the note.
+{line} `(integer)` The line number (1-indexed) where the task was found.
+{description} `(string)` The text of the line where the task was found.
+{status} `(string)` The status of the task.
+
+------------------------------------------------------------------------------
+                                                  *obsidian.Client.find_tasks()*
+                          `Client.find_tasks`({self})
+Return ~
+`(obsidian.Task[])`
+
+------------------------------------------------------------------------------
+                                       *obsidian.Client.get_task_status_names()*
+                     `Client.get_task_status_names`({self})
+Build the list of task status names sorted by order
+Return ~
+`(string[])`
+
 ------------------------------------------------------------------------------
 Class ~
 {obsidian.note.HeaderAnchor}