open5e-api icon indicating copy to clipboard operation
open5e-api copied to clipboard

Add docstrings to files, classes, functions

Open Gredelston opened this issue 2 years ago • 1 comments

More and more devs are joining the project, thanks to the shout-out on SlyFlourish's podcast. As projects scale and gain contributors, style and documentation become increasingly important. Let's start by adding docstrings.That way, new contributors will know what they're doing, and they will be encouraged to document their own code, too.

I propose that we follow PEP 8 for overall Python style and PEP 257 for docstring conventions specifically.

Gredelston avatar Mar 09 '23 17:03 Gredelston

I've started working on this on my fork. Also reordering imports in compliance with PEP-8, adding shebangs... simple style stuff.

Gredelston avatar Mar 09 '23 17:03 Gredelston

PEP8 has mostly been applied to the v2 app. 99% of relevant classes have docstrings. We're stalling dev on v1, so I think the intent of this is closed.

augustjohnson avatar Aug 08 '24 21:08 augustjohnson