Skip to content

C API docs: Py_IncRef and Py_DecRef are not documented as functions #91755

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.

Sign up for GitHub

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

Jump to bottom
Closed
encukou opened this issue Apr 20, 2022 · 1 comment
Closed

C API docs: Py_IncRef and Py_DecRef are not documented as functions #91755

encukou opened this issue Apr 20, 2022 · 1 comment
Labels
docs Documentation in the Doc dir easy topic-C-API

Comments

@encukou
Copy link
Member

encukou commented Apr 20, 2022

Documentation

Py_IncRef and Py_DecRef are mentioned in prose at the end of Reference Counting docs. They should be documented as C functions so they show up in the index and can be linked.
@encukou encukou added docs Documentation in the Doc dir easy labels Apr 20, 2022
CharlieZhao95 added a commit to CharlieZhao95/cpython that referenced this issue Apr 22, 2022
@CharlieZhao95
pythongh-91755: Document Py_IncRef and Py_DecRef as C function.
50a0ce1
@erlend-aasland erlend-aasland mentioned this issue May 18, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 18, 2022
@CharlieZhao95 @miss-islington
pythongh-91755: Document Py_IncRef and Py_DecRef as C functions (pyth…
2c58d4e 
…onGH-91805)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 18, 2022
@CharlieZhao95 @miss-islington
pythongh-91755: Document Py_IncRef and Py_DecRef as C functions (pyth…
dc0557a 
…onGH-91805)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
erlend-aasland added a commit that referenced this issue May 18, 2022
@CharlieZhao95 @erlend-aasland @JelleZijlstra
gh-91755: Document Py_IncRef and Py_DecRef as C functions (#91805)
58a3d28 
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
miss-islington added a commit that referenced this issue May 18, 2022
@miss-islington @CharlieZhao95
gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805)
1815d8e 
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
miss-islington added a commit that referenced this issue May 18, 2022
@miss-islington @CharlieZhao95
gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805)
fad72d0 
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
@erlend-aasland
Copy link
Contributor

Fixed by:

vstinner added a commit that referenced this issue May 18, 2022
@vstinner
gh-91755: Remove doc of C API private refcount functions (#92918)
e0477ae 
These functions should only be used by Python internals.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy topic-C-API
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vstinner @encukou @erlend-aasland