[Docstring-checkins] CVS: dps/spec pep-0257.txt,1.3,1.4
Status: Pre-Alpha
Brought to you by:
goodger
From: David G. <go...@us...> - 2002-04-18 02:53:34
|
Update of /cvsroot/docstring/dps/spec In directory usw-pr-cvs1:/tmp/cvs-serv15639/dps/spec Modified Files: pep-0257.txt Log Message: fixed whitespace Index: pep-0257.txt =================================================================== RCS file: /cvsroot/docstring/dps/spec/pep-0257.txt,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** pep-0257.txt 28 Mar 2002 04:35:18 -0000 1.3 --- pep-0257.txt 18 Apr 2002 02:53:31 -0000 1.4 *************** *** 44,48 **** A docstring is a string literal that occurs as the first statement ! in a module, function, class, or method definition. Such a docstring becomes the __doc__ special attribute of that object. --- 44,48 ---- A docstring is a string literal that occurs as the first statement ! in a module, function, class, or method definition. Such a docstring becomes the __doc__ special attribute of that object. *************** *** 159,163 **** by the module, with a one-line summary of each. (These summaries generally give less detail than the summary line in the object's ! docstring.) The docstring for a package (i.e., the docstring of the package's __init__.py module) should also list the modules and subpackages exported by the package. --- 159,163 ---- by the module, with a one-line summary of each. (These summaries generally give less detail than the summary line in the object's ! docstring.) The docstring for a package (i.e., the docstring of the package's __init__.py module) should also list the modules and subpackages exported by the package. *************** *** 190,194 **** case sensitive and the argument names can be used for keyword arguments, so the docstring should document the correct argument ! names. It is best to list each argument on a separate line. For example:: --- 190,194 ---- case sensitive and the argument names can be used for keyword arguments, so the docstring should document the correct argument ! names. It is best to list each argument on a separate line. For example:: |