[Python-checkins] cpython (2.7): Closes #19342: improve docstrings in grp module.

[georg.brandl]

https://hg.python.org/cpython/rev/de0ca868d44f
changeset:   92743:de0ca868d44f
branch:      2.7
parent:      92738:fd2530294d50
user:        Georg Brandl <georg at python.org>
date:        Thu Oct 02 08:34:41 2014 +0200
summary:
  Closes #19342: improve docstrings in grp module.

files:
  Modules/grpmodule.c |  12 ++++++------
  1 files changed, 6 insertions(+), 6 deletions(-)


diff --git a/Modules/grpmodule.c b/Modules/grpmodule.c
--- a/Modules/grpmodule.c
+++ b/Modules/grpmodule.c
@@ -157,11 +157,11 @@
 
 static PyMethodDef grp_methods[] = {
     {"getgrgid",	grp_getgrgid,	METH_O,
-     "getgrgid(id) -> tuple\n\
+     "getgrgid(id) -> (gr_name,gr_passwd,gr_gid,gr_mem)\n\
 Return the group database entry for the given numeric group ID.  If\n\
 id is not valid, raise KeyError."},
     {"getgrnam",	grp_getgrnam,	METH_O,
-     "getgrnam(name) -> tuple\n\
+     "getgrnam(name) -> (gr_name,gr_passwd,gr_gid,gr_mem)\n\
 Return the group database entry for the given group name.  If\n\
 name is not valid, raise KeyError."},
     {"getgrall",	grp_getgrall,	METH_NOARGS,
@@ -178,10 +178,10 @@
 Group entries are reported as 4-tuples containing the following fields\n\
 from the group database, in order:\n\
 \n\
-  name   - name of the group\n\
-  passwd - group password (encrypted); often empty\n\
-  gid    - numeric ID of the group\n\
-  mem    - list of members\n\
+  gr_name   - name of the group\n\
+  gr_passwd - group password (encrypted); often empty\n\
+  gr_gid    - numeric ID of the group\n\
+  gr_mem    - list of members\n\
 \n\
 The gid is an integer, name and password are strings.  (Note that most\n\
 users are not explicitly listed as members of the groups they are in\n\

-- 
Repository URL: https://hg.python.org/cpython