Python docstring Format

Ich würde gerne etwas Doku in den Code einbringen for obvious reasons.

Ist uns das Format der docstrings egal oder wollen wir uns auf ein Format einigen? Ich würde letzteres bevorzugen, habe aber keine Präferenz, welches Format es sein sollte.

Gute Diskussion hier:

Go ahead, thanks!

Wenn wir perspektivisch einmal das hervorragende https://www.sphinx-doc.org/ für das Rendern der Dokumentation verwenden wollen, wäre es vermutlich praktisch, gleich das native reStructuredText-Format zu verwenden.

Ob das wohl daran liegt, das das der default bei PyCharm ist, den hier manche benutzen? :grin:

Ok, reST it is. Ich schau mal, wie gut der pyment funktioniert. Dann haben wir zumindest überall einen stub drin.

1 Like

@Andreas - willst Du den pull request für die docstrings gegen master oder den esp32 branch?

Falls das möglich ist, gerne gegen master - solange wir noch an Improve compatibility with Genuine MicroPython on ESP32 by poesel · Pull Request #23 · hiveeyes/hiveeyes-micropython-firmware · GitHub arbeiten.