ref: 1cea664b04e08995b34104689334fc2b82fefe88
parent: cf7777cfbad1c15ca9c62bc1ed6b3b1532f7aec3
author: halfwit <michaelmisch1985@gmail.com>
date: Thu Nov 28 08:31:31 PST 2019
Fill out example
--- a/README.md
+++ b/README.md
@@ -72,7 +72,8 @@
Since .todo files are simply text files, you can also achieve any of the above by opening and editing the file by hand.
The schema for an entry is non-complicated. Given a line in your code, such as:
-`BUG(halfwit) - There's an issue with my code and I don't understand why`, an entry would be populated as follows.
+`BUG(halfwit) - There's an issue with my code and I don't understand why`
+, an entry would be populated as follows.
```
general:
@@ -82,20 +83,25 @@
Additionally, tags are used as a header. Multiple tags are fine as well!
```
-// BUG(halfwit): [enhancement] [#354] There's an issue with my code and I seem to have figured it out
+// BUG(halfwit): [enhancement] [#354] There's an issue with my code and I don't know why
// requires [#353]
```
+Would result with the following:
+
```
[enhancement] [#354]: requires [#353]
-BUG(halfwit) - There's an issue with my code and I seem to have figured it out
+BUG(halfwit) - There's an issue with my code and I don't know why
```
A more interesting example generated like this would have related nodes
```
-[]: requires [#353]
+[#123]: requires [#353] [#124]
BUG(halfwit) - There's an issue with my code and I seem to have figured it out
+
+[#124]:
+TODO - write the first bit of code
[#354]: requires [#352]
TODO - Write the code