summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-10-02 06:34:41 (GMT)
committerGeorg Brandl <georg@python.org>2014-10-02 06:34:41 (GMT)
commit41ea1f4f26667c1741368567716d38febc2648a4 (patch)
treeb039f2448bf4f0aab0a1645a47067ecd9220a911 /Modules
parentea7ec2b48115c1b70d4472015703c56634a54edf (diff)
downloadcpython-41ea1f4f26667c1741368567716d38febc2648a4.zip
cpython-41ea1f4f26667c1741368567716d38febc2648a4.tar.gz
cpython-41ea1f4f26667c1741368567716d38febc2648a4.tar.bz2
Closes #19342: improve docstrings in grp module.
Diffstat (limited to 'Modules')
-rw-r--r--Modules/grpmodule.c12
1 files changed, 6 insertions, 6 deletions
diff --git a/Modules/grpmodule.c b/Modules/grpmodule.c
index c8a9372..da78253 100644
--- a/Modules/grpmodule.c
+++ b/Modules/grpmodule.c
@@ -152,11 +152,11 @@ grp_getgrall(PyObject *self, PyObject *ignore)
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_VARARGS,
- "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,
@@ -173,10 +173,10 @@ PyDoc_STRVAR(grp__doc__,
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\