Path: csiph.com!usenet.pasdenom.info!dedibox.gegeweb.org!gegeweb.eu!gegeweb.org!eternal-september.org!feeder.eternal-september.org!mx02.eternal-september.org!.POSTED!not-for-mail From: Marko Rauhamaa Newsgroups: comp.lang.python Subject: Re: Most gratuitous comments Date: Tue, 25 Nov 2014 14:53:44 +0200 Organization: A noiseless patient Spider Lines: 12 Message-ID: <87tx1nfnl3.fsf@elektro.pacujo.net> References: <546d7505$0$12899$c3e8da3$5496439d@news.astraweb.com> <25fa214f-2060-46a8-bebf-d191d69e9a9c@googlegroups.com> <546e7644$0$13014$c3e8da3$5496439d@news.astraweb.com> <6ab51e97-19c5-4008-a755-c55eb71469ba@googlegroups.com> <87fvdd6o5c.fsf@elektro.pacujo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: mx02.eternal-september.org; posting-host="ff5cf27ef3d5b31f034d3b72bdc27a41"; logging-data="26857"; mail-complaints-to="abuse@eternal-september.org"; posting-account="U2FsdGVkX1+feMAR7G5SM7ObirFN6FPl" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (gnu/linux) Cancel-Lock: sha1:E6DWIKqtmY7e7g9C5rIjwuD8rqc= sha1:U/dPirxbDuOCE4i6PNvEg2Ck514= Xref: csiph.com comp.lang.python:81507 Marco Buttu : > To acknowledge the OP, the statistics module deserves to be taken as > example for writing good comments and docstrings: > > https://hg.python.org/cpython/file/3.4/Lib/statistics.py True, it is done with good style. It concentrates on documenting use and lets the implementation document itself. Marko