dtomlinson/tembo
1
0
Fork 0
mirror of https://github.com/dtomlinson91/tembo.git synced 2025-12-22 09:45:44 +00:00
Code Issues Projects Releases Wiki Activity

updating TODO

Browse Source
This commit is contained in:
Daniel Tomlinson
2021-10-25 14:34:20 +01:00
parent 5348fb72e4
commit 293a4a1329
1 changed files with 17 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
TODO.todo
View File

@@ -1,13 +1,10 @@
Priority: Priority:
✔ Go through code TODOs @done(21-10-25 05:52) ✔ Document the python/logging/typing in Trilium @done(21-10-25 14:33)
☐ Check code order and make sure things are where they should be
☐ Document the python/logging/typing in Trilium
☐ Write the tests ☐ Write the tests
☐ Docstrings
Functionality: Functionality:
☐ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages ☐ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages?
Bug:
Tests: Tests:
☐ Write tests! @2d ☐ Write tests! @2d
@@ -19,21 +16,7 @@ VSCode:
Logging: Logging:
Documentation: Documentation:
☐ Document usage of Panaetius in a module ☐ a
Using the logger, initialising with the config path etc
☐ Uses `strftime` tokens: <https://strftime.org>
☐ Document latest typing.
☐ Using from `__future__` with `|`
☐ `using Tuple[str, ...]`
☐ `Sequence` vs `Collection`
☐ Document how to do docstrings in python. Don't document `__init__` do it in class.
Should update the default gist to hide the `__init__` messages
☐ Document using jinja2 briefly and link to Tembo (link to <https://zetcode.com/python/jinja/>)
Logging:
☐ How to raise + debug an exception?
☐ Document how to raise a logger.critical instead of exception
in a try, except you can just do logger.critical(exec_info=1) to print the stack
Tembo: Tembo:
☐ Document creating new Tembo config ☐ Document creating new Tembo config
@@ -46,6 +29,19 @@ Logging:
clone the repo, delete .git, git init, configure and add git origin clone the repo, delete .git, git init, configure and add git origin
Archive: Archive:
✔ Go through code TODOs @done(21-10-25 05:52) @project(Priority)
✔ Check code order and make sure things are where they should be @done(21-10-25 13:31) @project(Priority)
✔ Add version option @done(21-10-25 13:40) @project(Functionality)
✘ Document usage of Panaetius in a module @cancelled(21-10-25 13:31) @project(Logging.Documentation)
✘ Uses `strftime` tokens: <https://strftime.org> @cancelled(21-10-25 13:32) @project(Logging.Documentation)
✔ Document latest typing. @done(21-10-25 14:14) @project(Logging.Documentation)
✔ Using from `__future__` with `|` @done(21-10-25 13:48) @project(Logging.Documentation)
✔ `using Tuple[str, ...]` @done(21-10-25 13:49) @project(Logging.Documentation)
✔ `Sequence` vs `Collection` @done(21-10-25 13:55) @project(Logging.Documentation)
✔ Document how to do docstrings in python. Don't document `__init__` do it in class. @done(21-10-25 13:57) @project(Logging.Documentation)
✔ Document using jinja2 briefly and link to Tembo (link to <https://zetcode.com/python/jinja/>) @done(21-10-25 14:21) @project(Logging.Documentation)
✔ How to raise + debug an exception? @done(21-10-25 14:32) @project(Logging.Documentation.Logging)
✔ Document how to raise a logger.critical instead of exception @done(21-10-25 14:32) @project(Logging.Documentation.Logging)
✔ tokens @done(21-10-25 05:35) @project(Bug) ✔ tokens @done(21-10-25 05:35) @project(Bug)
✔ Handle case where there are no scopes in the config and command is invoked. @done(21-10-25 04:32) @project(Functionality) ✔ Handle case where there are no scopes in the config and command is invoked. @done(21-10-25 04:32) @project(Functionality)
✔ Have an `--example` flag to `new` that prints an example given in the `config.yml` @done(21-10-25 04:55) @project(Functionality) ✔ Have an `--example` flag to `new` that prints an example given in the `config.yml` @done(21-10-25 04:55) @project(Functionality)