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

Thu Apr 14 23:55:15 EDT 2022

https://github.com/python/cpython/commit/bd26ef5e9e701d2ab3509a49d9351259a3670772
commit: bd26ef5e9e701d2ab3509a49d9351259a3670772
branch: main
author: Jens Holzkämper <jens at holzkaemper.berlin>
committer: JelleZijlstra <jelle.zijlstra at gmail.com>
date: 2022年04月14日T20:55:07-07:00
summary:
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 at gmail.com>
files:
M Doc/library/os.rst

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 60eac2f78572e..254d6e192cdf0 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.
 
