Skip to content

Commit 788c9d1

Browse files
committed
docs: Document thoroughly the 'blocking' and 'blocked' instructions.
1 parent 6b6bbb9 commit 788c9d1

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

docs/Queries/Filters.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,72 @@ Find any tasks that have status symbols you have not yet added to your Tasks set
453453

454454
## Filters for Task Dependencies
455455

456+
At a high level, task dependencies define the order in which you want to work on a set of tasks. You can read more about them in [[Task Dependencies]].
457+
458+
### Blocking
459+
460+
- `is blocking`
461+
- This shows tasks that you probably want to do first, as they are preventing other tasks from being done.
462+
- `is not blocking`
463+
- This shows tasks that are not preventing others from being done, so perhaps may be considered as lower priority.
464+
- This would typically be used with `not done`.
465+
466+
A task is treated as `blocking` if:
467+
468+
- it has an `id` value,
469+
- at least one other task in the vault has that `id` value in its `blockedBy` list,
470+
- both tasks have status type `TODO` or `IN_PROGRESS`.
471+
472+
For example:
473+
474+
```text
475+
- [ ] I am blocking 🆔 12345
476+
- [ ] I am not blocking ⛔️ 12345
477+
```
478+
479+
Note also:
480+
481+
- Only direct dependencies are considered.
482+
- Tasks with status type `DONE`, `CANCELLED` or `NON_TASK` are never treated as `blocked`.
483+
484+
For more information, see [[Task Dependencies]].
485+
486+
> [!released]
487+
>
488+
> - `is blocking` and `is not blocking` were introduced in Tasks X.Y.Z.
489+
490+
### Blocked
491+
492+
- `is blocked`
493+
- This shows tasks you cannot currently do, as they are waiting for another task to be completed.
494+
- `is not blocked`
495+
- This shows tasks that are not waiting for any other tasks to be completed.
496+
- This would typically be used with `not done`.
497+
498+
A task is treated as `blocked` if:
499+
500+
- it has one or more `blockedBy` values,
501+
- its `blockedBy` list includes the id any tasks in the vault,
502+
- both tasks have status type `TODO` or `IN_PROGRESS`.
503+
504+
For example:
505+
506+
```text
507+
- [ ] I am not blocked 🆔 12345
508+
- [ ] I am blocked ⛔️ 12345
509+
```
510+
511+
Note also:
512+
513+
- Only direct dependencies are considered.
514+
- Tasks with status type `DONE`, `CANCELLED` or `NON_TASK` are never treated as `blocked`.
515+
516+
For more information, see [[Task Dependencies]].
517+
518+
> [!released]
519+
>
520+
> - `is blocked` and `is not blocked` were introduced in Tasks X.Y.Z.
521+
456522
### Id
457523

458524
- `has id`

0 commit comments

Comments
 (0)