updating docstrings, adding duty, updating README

This commit is contained in:
2021-11-14 08:33:22 +00:00
parent 89655d46ae
commit 3a2a8951a7
13 changed files with 405 additions and 84 deletions

View File

@@ -1,11 +1,8 @@
Testing:
To Write:
☐ Test the Config file skipping header with `skip_header_init`
☐ Document coverage commands
`coverage run --source=./panaetius -m pytest`
`coverage report` & `coverage html` > gives ./htmlcov/index.html
☐ Document for abstract methods should raise NotImplementedError
☐ Document https://stackoverflow.com/a/9212387
Documentation:
☐ Rewrite documentation using `mkdocs` and using `.md`.
☐ Update the metadata in the `pyproject.toml`.
@@ -13,13 +10,19 @@ Documentation:
☐ Document the logging strategy
CLI tools should use `logger.critical` and raise SystemExit(1)
Libraries should raise custom errors and have a `logger.critical(exec_info=1)`
Typing:
☐ Go over typing, make sure what's passed in are generics where possible.
Docstrings:
☐ Update class docstrings so attributes are in class.
Misc:
☐ Use the python runner to build the docs & run the tests (including coverage html)
coverage run -m pytest && coverage report && coverage html
☐ document this in trilium
Archive:
✔ Test the Config file skipping header with `skip_header_init` @done(21-10-25 23:34) @project(Testing.To Write)
✔ Document for abstract methods should raise NotImplementedError @done(21-10-25 23:39) @project(Testing.To Write)
✔ Document https://stackoverflow.com/a/9212387 @done(21-10-25 23:40) @project(Testing.To Write)
✘ Bump the version to release 2.0 @cancelled(21-10-23 05:36) @project(Misc)
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.No Config File)
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.Config File)