Provide code comments and documentation

Question

joepal1976 opened this issue 7 months ago · 3 comments

While some care has been taken to provide inline code documentation, it is still patchy.

At least all the modules under mpfb.services should have module and function doc strings.

Further, there needs to be a comprehensible explanation of the code structure, the basic principles and hints on how to do common stuff.

Answer 1 · 2024-06-16T13:39:12.000Z

Not going to prioritize this for the beta.

Answer 2 · 2024-08-25T15:00:03.000Z

At least the core logic is now linted and commented. It'll have to be enough for now.

Ideally, the entities should be cleaned up too, but won't block the release on that.