]> granicus.if.org Git - python/commit
More trivial comment -> docstring transformations by Ka-Ping Yee,
authorGuido van Rossum <guido@python.org>
Fri, 4 Feb 2000 15:10:34 +0000 (15:10 +0000)
committerGuido van Rossum <guido@python.org>
Fri, 4 Feb 2000 15:10:34 +0000 (15:10 +0000)
commit54f22ed30bab2e64909ba2d79205cb4b87c69db2
treeed398e54a04bf75e3f26845e7aacb72452a10627
parent8b6323d3ef78042118c08703f26cb2adf741ea2e
More trivial comment -> docstring transformations by Ka-Ping Yee,
who writes:

Here is batch 2, as a big collection of CVS context diffs.
Along with moving comments into docstrings, i've added a
couple of missing docstrings and attempted to make sure more
module docstrings begin with a one-line summary.

I did not add docstrings to the methods in profile.py for
fear of upsetting any careful optimizations there, though
i did move class documentation into class docstrings.

The convention i'm using is to leave credits/version/copyright
type of stuff in # comments, and move the rest of the descriptive
stuff about module usage into module docstrings.  Hope this is
okay.
30 files changed:
Lib/dospath.py
Lib/filecmp.py
Lib/fpformat.py
Lib/gopherlib.py
Lib/gzip.py
Lib/htmlentitydefs.py
Lib/imghdr.py
Lib/keyword.py
Lib/linecache.py
Lib/macpath.py
Lib/mailcap.py
Lib/mhlib.py
Lib/mimetools.py
Lib/mimify.py
Lib/multifile.py
Lib/mutex.py
Lib/netrc.py
Lib/nntplib.py
Lib/nturl2path.py
Lib/os.py
Lib/pdb.py
Lib/pickle.py
Lib/pipes.py
Lib/popen2.py
Lib/posixfile.py
Lib/posixpath.py
Lib/profile.py
Lib/pstats.py
Lib/pty.py
Lib/py_compile.py