From 293a4a1329a8708ee71565f5d6dc4886279a68d4 Mon Sep 17 00:00:00 2001 From: Daniel Tomlinson Date: Mon, 25 Oct 2021 14:34:20 +0100 Subject: [PATCH] updating TODO --- TODO.todo | 38 +++++++++++++++++--------------------- 1 file changed, 17 insertions(+), 21 deletions(-) diff --git a/TODO.todo b/TODO.todo index 2e2e531..a6483f4 100644 --- a/TODO.todo +++ b/TODO.todo @@ -1,13 +1,10 @@ Priority: - ✔ Go through code TODOs @done(21-10-25 05:52) - ☐ Check code order and make sure things are where they should be - ☐ Document the python/logging/typing in Trilium + ✔ Document the python/logging/typing in Trilium @done(21-10-25 14:33) ☐ Write the tests + ☐ Docstrings Functionality: - ☐ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages - -Bug: + ☐ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages? Tests: ☐ Write tests! @2d @@ -19,21 +16,7 @@ VSCode: Logging: Documentation: - ☐ Document usage of Panaetius in a module - Using the logger, initialising with the config path etc - ☐ Uses `strftime` tokens: - ☐ 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 ) - - 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 + ☐ a Tembo: ☐ Document creating new Tembo config @@ -46,6 +29,19 @@ Logging: clone the repo, delete .git, git init, configure and add git origin 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: @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 ) @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) ✔ 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)