From: Jens Holzkämper <jens@holzkaemper.berlin>
Date: Fri, 15 Apr 2022 03:55:07 +0000 (+0200)
Subject: bpo-40376: slightly improved the wording for os.getgrouplist (GH-19702)
X-Git-Tag: v3.11.0b1~364
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bd26ef5e9e701d2ab3509a49d9351259a3670772;p=thirdparty%2FPython%2Fcpython.git

bpo-40376: slightly improved the wording for os.getgrouplist (GH-19702)

The documentation for os.getgrouplist potentially read like it
returned all groups a user belongs to but it potentially doesn't.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 60eac2f78572..254d6e192cdf 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -355,7 +355,8 @@ process and user.
 
    Return list of group ids that *user* belongs to. If *group* is not in the
    list, it is included; typically, *group* is specified as the group ID
-   field from the password record for *user*.
+   field from the password record for *user*, because that group ID will
+   otherwise be potentially omitted.
 
    .. availability:: Unix.