DISTORTEC / distortos

object-oriented C++ RTOS for microcontrollers
https://distortos.org/
Mozilla Public License 2.0
434 stars 67 forks source link

Use almost PEP 257 docstrings #50

Closed aelspire closed 6 years ago

aelspire commented 6 years ago

Changes current docstrings. New ones use almost PEP 257 style. I used more lenient style for newlines and grammar for classes' docstrings.

FreddieChopin commented 6 years ago

I would just add some more backticks in the patch for pretty-printers, for example this:

"""Print distortos::internal::ThreadList."""

could become:

"""Print `distortos::internal::ThreadList`."""
aelspire commented 6 years ago

Ok, changed