[Python-Dev] Breaking undocumented API (original) (raw)

Eli Bendersky eliben at gmail.com
Tue Nov 9 06:30:08 CET 2010

On Tue, Nov 9, 2010 at 04:07, R. David Murray <rdmurray at bitdance.com> wrote:

On Mon, 08 Nov 2010 18:10:17 -0600, Ron Adam <rrr at ronadam.com> wrote: > def privateapi(): > # > # 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 -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://mail.python.org/pipermail/python-dev/attachments/20101109/a724f9cc/attachment.html>

More information about the Python-Dev mailing list