From 54f22ed30bab2e64909ba2d79205cb4b87c69db2 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Fri, 4 Feb 2000 15:10:34 +0000 Subject: 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. --- Lib/netrc.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'Lib/netrc.py') diff --git a/Lib/netrc.py b/Lib/netrc.py index 9f47babdef..d24c388db3 100644 --- a/Lib/netrc.py +++ b/Lib/netrc.py @@ -1,3 +1,5 @@ +"""An object-oriented interface to .netrc files.""" + # Module and documentation by Eric S. Raymond, 21 Dec 1998 import os, shlex @@ -63,7 +65,7 @@ class netrc: raise SyntaxError, "bad follower token %s, file %s, line %d"%(tt,file,lexer.lineno) def authenticators(self, host): - "Return a (user, account, password) tuple for given host." + """Return a (user, account, password) tuple for given host.""" if self.hosts.has_key(host): return self.hosts[host] elif self.hosts.has_key('default'): @@ -72,7 +74,7 @@ class netrc: return None def __repr__(self): - "Dump the class data in the format of a .netrc file" + """Dump the class data in the format of a .netrc file.""" rep = "" for host in self.hosts.keys(): attrs = self.hosts[host] -- cgit v1.2.1