status-im
/
todo-to-docs
mirror of https://github.com/status-im/todo-to-docs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added additional todo item

This commit is contained in:
Samuel Hawksby-Robinson 2021-03-05 15:21:01 +00:00
parent 715a868281
commit 2be93c6c58
No known key found for this signature in database
GPG Key ID: 64CF99D4A64A1205
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -22,6 +22,7 @@ todo-to-doc
## Sample Output ## Sample Output
...
- 📁 params<br/> - 📁 params<br/>
- 📃 config.go<br/> - 📃 config.go<br/>
- ⬜ Todo:<br/> - ⬜ Todo:<br/>
@ -41,4 +42,6 @@ todo-to-doc
*Description* : TODO(adam): investigate if it's worth to keep the peer in the queue<br/> *Description* : TODO(adam): investigate if it's worth to keep the peer in the queue<br/>
until the server confirms it is added and in the meanwhile only adjust its priority.<br/> until the server confirms it is added and in the meanwhile only adjust its priority.<br/>
...
For a full sample output [see here](sample/sample.md) For a full sample output [see here](sample/sample.md)

4
main.go
View File

@ -2,6 +2,8 @@ package main
import "fmt" import "fmt"
// TODO add support for `status-react`
// TODO implement dynamic comment token selection, could maybe work similar to entityTracker{} // TODO implement dynamic comment token selection, could maybe work similar to entityTracker{}
// TODO check if to-do is just above a function or struct, if so assume the to-do is about the function // TODO check if to-do is just above a function or struct, if so assume the to-do is about the function
@ -26,5 +28,5 @@ func main() {
panic(err) panic(err)
} }
fmt.Println(tf.foundTree.Markdown()) fmt.Println(tf.foundTree)
} }