fritz-marshal / planning

https://github.com/orgs/fritz-marshal/projects/2/views/6
0 stars 0 forks source link

API Docstring cleanup #5

Closed Theodlz closed 1 week ago

Theodlz commented 2 months ago

The docstrings of our handlers and their respective HTTP methods aren't very clean. Since those are used to auto generate the API documentation, it results in a documentation page that is hard to navigate, badly documented, and just not usable.

An easy first step would be to simply scan through all of the handlers and make sure that the docstrings are correct and that their tags & categories are correct as well.