4 ms·
The state of Python documentation in general is terrible. "This function accepts the following arguments, half of them are documented below. It also accepts kw
by RadiozRadioz 3y ago
The state of Python documentation in general is terrible.
"This function accepts the following arguments, half of them are documented below. It also accepts kwargs, but we won't tell you what to put in there or where it ends up. To keep you on your toes, we throw some special mystery exceptions that we won't tell you about. Do they have a common base? It's a secret. Have fun digging in the source code like a chump; Python is easy to read, you'll figure it out."
Not to mention that there aren't any overarching standards like JavaDoc. There was a PEP a while back describing ReST with some inconsistent examples of how to use it to document code. Most projects I've seen pick one of the competing standards, half-ass and inconsistently follow it, then rely just on examples to document usage. It's a mixed up hodgepodge of incomplete prose that's difficult to read with a machine.