Style for docstring

Michael F. Stemper michael.stemper at gmail.com
Fri Apr 22 15:36:27 EDT 2022


I'm writing a function that is nearly self-documenting by its name,
but still want to give it a docstring. Which of these would be
best from a stylistic point of view:


   Tells caller whether or not a permutation is even.

   Determines if a permutation is even. (Alternative is that it's odd.)

   Returns True if permutation is even, False if it is odd.


(Before somebody suggests it, I'm not going to put six weeks' worth
of a course in group theory in there to help somebody who doesn't
know what those standard terms mean.)

-- 
Michael F. Stemper
87.3% of all statistics are made up by the person giving them.


More information about the Python-list mailing list