RE: imperative mood in docstrings

2014-02-13 Thread bagrat lazaryan
thank you all! bagratte -- https://mail.python.org/mailman/listinfo/python-list

Re: imperative mood in docstrings

2014-02-09 Thread Steven D'Aprano
On Sun, 09 Feb 2014 16:05:59 +0400, bagrat lazaryan wrote: > 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").

Re: imperative mood in docstrings

2014-02-09 Thread Chris Angelico
On Mon, Feb 10, 2014 at 4:53 AM, Ethan Furman wrote: > Shouldn't that be: > > class Pig: > def fly(self): > "Soar gracefully through the air if a hot place is very cold." > if hell is frozen: > self.sprout_wings() > self.altitude += 10 >

Re: imperative mood in docstrings

2014-02-09 Thread Terry Reedy
On 2/9/2014 7:05 AM, bagrat lazaryan wrote: 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 beh

Re: imperative mood in docstrings

2014-02-09 Thread Ethan Furman
On 02/09/2014 08:52 AM, Roy Smith wrote: In article , bagrat lazaryan wrote: 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", "

Re: imperative mood in docstrings

2014-02-09 Thread Chris “Kwpolska” Warrick
On Sun, Feb 9, 2014 at 5:52 PM, Roy Smith wrote: > In article , > bagrat lazaryan wrote: > >> 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 descript

Re: imperative mood in docstrings

2014-02-09 Thread Jussi Piitulainen
Mark Lawrence writes: > On 09/02/2014 12:05, bagrat lazaryan wrote: > > > 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",

Re: imperative mood in docstrings

2014-02-09 Thread Mark Lawrence
On 09/02/2014 12:05, bagrat lazaryan wrote: 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 beh

Re: imperative mood in docstrings

2014-02-09 Thread Roy Smith
In article , bagrat lazaryan wrote: > 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 b