Skip to content

Commit

Permalink
fix: Correct typos in README.md
Browse files Browse the repository at this point in the history
- Corrected spelling of "Detect" in Features section
- Fixed typo of "edited" in the description of :TWEditTask.
- Added :TWBufQueryTasks in the configuration section
  • Loading branch information
huantrinh1802 committed Apr 25, 2024
1 parent 78b6ada commit 12c1368
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The goals of this plugin are:
## Features

- [x] Injected and concealed Taskwarrior task
- [x] Dectect task (checkbox) in Markdown or similar files and register the task into Taskwarrior
- [x] Detect task (checkbox) in Markdown or similar files and register the task into Taskwarrior
- [x] Work with Markdown with ( - [ ])
- [ ] Docstring in Python
- [ ] JSDoc in JavaScript
Expand Down Expand Up @@ -201,7 +201,7 @@ If you are using `obsidian.nvim`, you can use the following configuration:
- `:TWUpdateCurrent`: quickly update the description of the task so you don't have to use the edit command
- `:TWEditTask`: toggle a float window, which can edit the task.
- Using the `task {id} edit` behind the scene
- It will update the description in the buffer if you editted it in the popup
- It will update the description in the buffer if you edited it in the popup
- `:TWView`: a quick view of more details of the task
- It is focusable so you can copy texts from their
- It will be dismissed once the cursor moves or reenter the buffer
Expand All @@ -225,11 +225,13 @@ If you are using `obsidian.nvim`, you can use the following configuration:
- `:TWQueryTasks`: similar to `taskwiki`'s viewport, render the output of the `task {query}` as the list of tasks
- Nested tasks are supported
- In-sync with where it is first created
- `:TWBufQueryTasks`: similar to `TWQueryTasks`, but this will scan the current buffer and run all the queries in the current buffer
- `:TWTaskScratch`: prompt a menu with the list of all saved queries, after an item is selected, a split window will open and render out the tasks of the selected query
- What it does is open a temporary file in `vim.fn.stdpath("data").."/m_taskwarrior_d.md"`, append the selected query and run `TWQueryTasks` on it
- There are two additional commands to use with the scratch window:
- `:TWScratchShow`: to show the hidden scratch window
- `:TWScratchHide`: to hide the scratch window

### Task Dependencies

- Nested checkboxes are depended on the parent checkbox
Expand Down

0 comments on commit 12c1368

Please sign in to comment.