On Mon, 08 Nov 2010 18:10:17 -0600, Ron Adam <rrr@ronadam.com> wrote:
> def _private_api():
> � � �#
> � � �# Isn't it a good practice to use comments here?
> � � �#
> � � �...

IMO, no.


FWIW, I agree completely. Docstrings are a part of Python I don't see a reason to leave out for "non-public" code. They're convenient in the beginning of functions and we all are used to seeing them there. IDE's use them to display helpful "tooltips" on functions, and so on.
">

(original) (raw)


On Tue, Nov 9, 2010 at 04:07, R. David Murray <rdmurray@bitdance.com> wrote:
On Mon, 08 Nov 2010 18:10:17 -0600, Ron Adam <rrr@ronadam.com> wrote:
> def \_private\_api():
> � � �#
> � � �# Isn't it a good practice to use comments here?
> � � �#
> � � �...

IMO, no.


FWIW, I agree completely. Docstrings are a part of Python I don't see a reason to leave out for "non-public" code. They're convenient in the beginning of functions and we all are used to seeing them there. IDE's use them to display helpful "tooltips" on functions, and so on.



Eli