Path: csiph.com!usenet.pasdenom.info!weretis.net!feeder1.news.weretis.net!news1.tnib.de!feed.news.tnib.de!news.tnib.de!newsfeed.freenet.ag!news2.euro.net!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail
Return-Path: <python-python-list@m.gmane.org>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
X-Spam-Status: OK 0.001
X-Spam-Evidence: '*H*': 1.00; '*S*': 0.00; 'explicitly': 0.04; 'defines': 0.07; 'received:80.91': 0.09; 'received:80.91.229': 0.09; 'received:gmane.org': 0.09; 'received:list': 0.09; 'terry': 0.09; 'suggest': 0.11; 'docstring': 0.16; 'received:80.91.229.3': 0.16; 'received:plane.gmane.org': 0.16; 'reedy': 0.16; 'stdlib.': 0.16; 'subject: \n ': 0.16; 'subject:? - ': 0.16; 'subject:non': 0.16; 'syntax,': 0.16; 'wrote:': 0.17; 'jan': 0.18; 'followed': 0.20; 'header:In-Reply-To:1': 0.25; 'header:User-Agent:1': 0.26; 'format,': 0.27; 'header:X-Complaints-To:1': 0.28; 'to:addr :python-list': 0.33; 'pm,': 0.35; 'subject:?': 0.35; 'received:org': 0.36; 'being': 0.37; 'subject:: ': 0.38; 'to:addr:python.org': 0.39; 'header:Received:5': 0.40; 'you.': 0.61; 'alec': 0.84; 'received:fios.verizon.net': 0.84
X-Injected-Via-Gmane: http://gmane.org/
To: python-list@python.org
From: Terry Reedy <tjreedy@udel.edu>
Subject: Re: Should Docstrings include RFC citations? - And are non PEP257 syntaxes frowned upon?
Date: Sat, 23 Feb 2013 21:51:07 -0500
References: <CAO+9iGcYXo2bZr-vGUwd_Nouj6287efpu_OGQ9cq32MY0Z4FXg@mail.gmail.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
X-Gmane-NNTP-Posting-Host: pool-173-75-251-66.phlapa.fios.verizon.net
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:17.0) Gecko/20130215 Thunderbird/17.0.3
In-Reply-To: <CAO+9iGcYXo2bZr-vGUwd_Nouj6287efpu_OGQ9cq32MY0Z4FXg@mail.gmail.com>
X-BeenThere: python-list@python.org
X-Mailman-Version: 2.1.15
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.2392.1361674308.2939.python-list@python.org>
Lines: 10
NNTP-Posting-Host: 2001:888:2000:d::a6
X-Trace: 1361674308 news.xs4all.nl 6982 [2001:888:2000:d::a6]:37799
X-Complaints-To: abuse@xs4all.nl
Xref: csiph.com comp.lang.python:39729

On 2/23/2013 1:14 PM, Alec Taylor wrote:
> PEP257 defines docstring syntax,

It suggest a docstring format, which is not religiously followed even in 
the stdlib. It explicitly disclaims being 'the law'. Do what works for you.


-- 
Terry Jan Reedy