Skip to content

grp.getgrgid parameter name in documentation incorrect #95233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
adamtheturtle opened this issue Jul 25, 2022 · 0 comments
Closed

grp.getgrgid parameter name in documentation incorrect #95233

adamtheturtle opened this issue Jul 25, 2022 · 0 comments
Labels
docs Documentation in the Doc dir triaged The issue has been accepted as valid by a triager.

Comments

@adamtheturtle
Copy link
Contributor

In https://docs.python.org/3/library/grp.html we see the heading:

grp.getgrgid(gid)

As per the following, the grp.getgrgid parameter is id and not gid.

>>> import sys
>>> sys.version
'3.9.13 (main, May 24 2022, 21:13:51) \n[Clang 13.1.6 (clang-1316.0.21.2)]'
>>> import grp
>>> grp.getgrgid(id=1)
grp.struct_group(gr_name='daemon', gr_passwd='*', gr_gid=1, gr_mem=['root'])
>>> grp.getgrgid(gid=1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: getgrgid() missing required argument 'id' (pos 1)
>>> 
@adamtheturtle adamtheturtle added the docs Documentation in the Doc dir label Jul 25, 2022
@hugovk hugovk added the triaged The issue has been accepted as valid by a triager. label Jul 25, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 2, 2022
…(gid -> id) (pythongh-95232)

(cherry picked from commit df7c8b9)

Co-authored-by: Adam Dangoor <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 2, 2022
…(gid -> id) (pythongh-95232)

(cherry picked from commit df7c8b9)

Co-authored-by: Adam Dangoor <[email protected]>
miss-islington added a commit that referenced this issue Aug 2, 2022
…> id) (gh-95232)

(cherry picked from commit df7c8b9)

Co-authored-by: Adam Dangoor <[email protected]>
miss-islington added a commit that referenced this issue Aug 2, 2022
…> id) (gh-95232)

(cherry picked from commit df7c8b9)

Co-authored-by: Adam Dangoor <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir triaged The issue has been accepted as valid by a triager.
Projects
None yet
Development

No branches or pull requests

3 participants