PEP 224: Point of information

[holdenweb]

I notice that at

python/meshtastic/__init__.py

Line 98 in 218e9b9

# Note: To follow PEP224, comments should be after the module variable.

the code assumes PEP 224 is a thing. Unfortunately, if you read the PEP you will find it was rejected, so the docstrings (for which I applaud the author) might just as well be comments. This may reduce the size of compiled files slightly, but otherwise should make absolutely no difference.

[ianmcorvidae]

PEP224 is relevant due to our current use of pdoc, which uses them: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-for-variables

While pdoc does support #: type comments instead, I'm not sure there's good reason to swap them over. It's possible pdoc won't serve our needs (still need to get the documentation back online in some form), at which point they could possibly be changed as well.