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

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>
(cherry picked from commit bd26ef5e9e701d2ab3509a49d9351259a3670772)

Co-authored-by: Jens Holzkämper <jens@holzkaemper.berlin>

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 2f7b37019e4a437238645d5c92dc3adef30f0e69..9dc49a2034144822f2b33497d74840a8985416c4 100644 (file)
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -287,7 +287,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.