[Python-Dev] Why is documentation not inline?

[Nick Coghlan]

On Mon, May 20, 2013 at 11:19 AM, Demian Brecht <demianbrecht at gmail.com> wrote:
> @nick: Yes, I realize what docstrings are for (I should have used that
> term rather than "inline" docs, my bad there :)). I think the problem
> that I've run into is simply inconsistencies in methods of documenting
> code (and the few times that it would have been helpful, what I was
> looking at had not been authored using docstrings).
>
> Is the usage of docstrings a requirement (or a strong suggestion) for
> new commits (I didn't see anything while reading the submission
> guidelines)? If not, would it perhaps be a worthy addition?

It's already covered by PEP 8 :
http://www.python.org/dev/peps/pep-0008/#documentation-strings

(and yes, reviewers should be checking for that in new patches and commits)

Cheers,
Nick.

--
Nick Coghlan   |   ncoghlan at gmail.com   |   Brisbane, Australia