Reformat and recomment code for mkdocstring #39
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
help wanted
Extra attention is needed
mkdocstring
is a great plugin formkdocs
which analyzes comments and generates documentation for the code. As can be seen in 1ae6fb0 the comments need to be modified so that every function/class conforms to the following format:I am sure this will only need to be done for the code that acts as an API (i.e. display objects, controllers, broadcasters, etc.) but if we could all just take a sec and reformat that this, it will make the documentation much more usable.
Thanks!
The text was updated successfully, but these errors were encountered: