Path: csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!feeder.erje.net!eu.feeder.erje.net!newsfeed.fsmpi.rwth-aachen.de!feeds.phibee-telecom.net!newsfeed.xs4all.nl!newsfeed3a.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
Return-Path: <bagratte@live.com>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
X-Spam-Status: OK 0.031
X-Spam-Evidence: '*H*': 0.94; '*S*': 0.00; 'logic': 0.09; 'pep': 0.09; 'books': 0.15; 'docstring': 0.16; "function's": 0.16; "method's": 0.16; 'command': 0.22; 'documenting': 0.31; 'from:addr:live.com': 0.36; 'behind': 0.37; 'to:addr:python-list': 0.38; 'to:addr:python.org': 0.39; '257': 0.84
X-TMN: [MQ8ZKhdOV9CRjXZoq0nQm8ZMFjSl/YCX]
X-Originating-Email: [bagratte@live.com]
From: bagrat lazaryan <bagratte@live.com>
To: <python-list@python.org>
Subject: imperative mood in docstrings
Date: Sun, 9 Feb 2014 16:05:59 +0400
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
X-Mailer: Microsoft Outlook 14.0
Thread-Index: Ac8ljjTU7INSl6JYRmKBDS/QblJm6Q==
Content-Language: en-us
X-OriginalArrivalTime: 09 Feb 2014 12:51:02.0366 (UTC) FILETIME=[9693D7E0:01CF2595]
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: <https://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: <https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups: comp.lang.python
Message-ID: <mailman.6584.1391950328.18130.python-list@python.org>
Lines: 7
NNTP-Posting-Host: 2001:888:2000:d::a6
X-Trace: 1391950328 news.xs4all.nl 2951 [2001:888:2000:d::a6]:37865
X-Complaints-To: abuse@xs4all.nl
Xref: csiph.com comp.lang.python:65753

pep 257 -- docstring conventions, as well as a myriad of books and other =
resources, recommend documenting a function's or method's effect as a =
command ("do this", "return that"), not as a description ("does this", =
"returns that"). what's the logic behind this recommendation?

bagratte