Skip to content

Commit 7e67d26

Browse files
committed
Improves hierarchy documentation (#7)
1 parent c46f97d commit 7e67d26

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,20 @@ The sequence matching the expression '^\s\*[ ].\*' marks a line as a TODO list i
3838
[X] Done
3939
```
4040

41-
###### Items Hierarchy
41+
##### Items Hierarchy
42+
43+
If one item has lesser indentation than the next one then the first one is meant
44+
to be **parent** and the second to be **child**.
45+
46+
###### Example
4247

4348
```
4449
[ ] Parent
4550
[ ] Child1
4651
[ ] Child2
4752
```
4853

49-
Rules:
54+
###### Rules:
5055
* Changig state of the parent item changes the state of all children items accorndantly
5156
* If all children items are marked done, parent will also be marked as done
5257
* If parent is marked as done and one of the children changes state to not done

doc/vim-todo-lists.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,12 @@ Example
6262
Items Hierarchy
6363
---------------
6464

65+
If one item has lesser indentation than the next one then the first one is meant
66+
to be 'parent' and the second to be 'child'.
67+
68+
Example
69+
-------
70+
6571
[ ] Parent
6672
[ ] Child1
6773
[ ] Child2

0 commit comments

Comments
 (0)