Closed broeder-j closed 1 year ago
Tests:
Concerning tests, the "developer guide" states that you are supposed to run tests. Is this not sufficient? See here
Concerning fixtures and stuff, the repo can't possibly "teach" how to use all the tools, except for the "demo code". I can create an empty conftest file (which is a good idea) and add some comments like "you can add your fixtures here" and refer to pytest docs. would this be ok from your point of view?
Also, I could add content to that conftest file that is only added if you choose to instantiate with demo code (CLI or API).
Docs:
Again, this is documented
Do you have improvement suggestions to that or is it not clear enough?
Describe the solution you'd like Create an empty conftest.py in the test directory. The conftest.py should contain text on how to run the tests. and a link to pytest, fixtures docs
poetry run poe docs
it runs the tests. So this may need some more documentation.Per default the docs dependencies are not installed, if this should be the case, the documentation misses how to install them. Also I would move the mkdocs.yml to the docs folder.