Path: csiph.com!x330-a1.tempe.blueboxinc.net!usenet.pasdenom.info!selfless.tophat.at!newsfeed.xs4all.nl!newsfeed5.news.xs4all.nl!xs4all!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail
Return-Path: <rosuav@gmail.com>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
X-Spam-Status: OK 0.007
X-Spam-Evidence: '*H*': 0.99; '*S*': 0.00; 'pm,': 0.10; 'received:209.85.214.174': 0.14; 'received:mail- iw0-f174.google.com': 0.14; 'wrote:': 0.14; '*really*': 0.16; 'angelico': 0.16; 'assume,': 0.16; 'code).': 0.16; 'from:addr:rosuav': 0.16; 'from:name:chris angelico': 0.16; 'maintainers': 0.16; 'refactoring': 0.16; 'roy': 0.16; 'forgotten': 0.16; 'subsequent': 0.16; '27,': 0.19; 'header:In- Reply-To:1': 0.21; '(on': 0.23; 'fri,': 0.23; 'message- id:@mail.gmail.com': 0.28; '"the': 0.28; 'received:209.85.214': 0.28; 'like,': 0.29; 'code,': 0.29; 'fairly': 0.30; 'to:addr :python-list': 0.33; "i'll": 0.34; 'chris': 0.34; 'nobody': 0.34; 'received:google.com': 0.37; 'received:209.85': 0.37; 'think': 0.38; 'but': 0.38; 'subject:: ': 0.38; 'some': 0.38; 'comments': 0.39; 'received:209': 0.39; 'to:addr:python.org': 0.39; 'read,': 0.40; 'address': 0.62; 'world': 0.63; 'subject:The': 0.69
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:in-reply-to:references:date :message-id:subject:from:to:content-type:content-transfer-encoding; bh=8xlbLqQol/IKzp51Nu4GSH0d4j1lNtl5n9vB1qUPeZ0=; b=p6HJPhR2hMdLj1rli5+JXtUIeIkOzeF2DmRuiZqwk79kbm4DjHI57KRvese+S2JP6T Zc4rpKcE11lbVK8zNObpRWL6RmLv2IK2z0tDGlSMNigUBxCMwj0Wwc0Y59fFeml0dduC CAh/9gIz+DNYb+BSwovDVzJf8jSebJAgWAct8=
DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type:content-transfer-encoding; b=XeTAu6Ky37I4KLjlT6hATEFUvZACbO5hxK25hgRwX/bJe+OelADRP+On7JEVMAMByC a4tMlxqXC6Ry6oroARttzfii9lh8rV3H6OL9mo67JCefKgan5Vzqw9HRtdUR9rlbXftg AvMtuw6esqKsUGRuTaRv09T3Lg/ieAMX74brY=
MIME-Version: 1.0
In-Reply-To: <roy-6F4F8A.22082526052011@news.panix.com>
References: <mailman.8533.1306409304.9058.python-list@python.org> <mailman.2126.1306435826.9059.python-list@python.org> <roy-6F4F8A.22082526052011@news.panix.com>
Date: Fri, 27 May 2011 15:13:15 +1000
Subject: Re: The worth of comments
From: Chris Angelico <rosuav@gmail.com>
To: python-list@python.org
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
X-BeenThere: python-list@python.org
X-Mailman-Version: 2.1.12
Precedence: list
List-Id: General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe: <http://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive: <http://mail.python.org/pipermail/python-list>
List-Post: <mailto:python-list@python.org>
List-Help: <mailto:python-list-request@python.org?subject=help>
List-Subscribe: <http://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups: comp.lang.python
Message-ID: <mailman.2145.1306473197.9059.python-list@python.org>
Lines: 15
NNTP-Posting-Host: 82.94.164.166
X-Trace: 1306473197 news.xs4all.nl 49175 [::ffff:82.94.164.166]:34713
X-Complaints-To: abuse@xs4all.nl
Xref: x330-a1.tempe.blueboxinc.net comp.lang.python:6371

On Fri, May 27, 2011 at 12:08 PM, Roy Smith <roy@panix.com> wrote:
> =A0Sometimes
> I'll drop in suggestions to future maintainers like, "consider
> refactoring with with perform_frobnitz_action()"

Usually, I address future-me with comments like that (on the
assumption that there's nobody in the world sadistic enough to want to
maintain my code). But I never name future-me, the comments will be
addressed to "the subsequent maintainer" or somesuch. I do assume,
though, that future-me has forgotten everything about the code, and
since past-me left some comments that current-me has read, I think the
assumption is fairly accurate. (Did I *really* write that code? It has
my name on it.....)

Chris Angelico