This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: PyType_Type is documented incorrectly
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: ammar2, da-woods, docs@python, miss-islington, python-dev
Priority: normal Keywords: patch

Created on 2020-09-29 20:58 by da-woods, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 22454 merged python-dev, 2020-09-29 21:06
PR 27583 merged miss-islington, 2021-08-03 17:22
PR 27584 merged miss-islington, 2021-08-03 17:26
Messages (5)
msg377683 - (view) Author: (da-woods) * Date: 2020-09-29 20:58
In the documentation PyType_Type is listed as a "PyObject*" (https://docs.python.org/3/c-api/type.html#c.PyType_Type). This is misleading because it is both not a pointer and is a PyTypeObject.

Other type objects are documented as "PyTypeObject" (see unicode https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_Type as an arbitrary example) so I think the documentation is just inconsistent for PyType_Type alone.
msg398841 - (view) Author: Ammar Askar (ammar2) * (Python committer) Date: 2021-08-03 17:21
New changeset ac811f9b5a68ce8756911ef2c8be83b46696018f by da-woods in branch 'main':
bpo-41886: Fix documented type of PyType_Type (GH-22454)
https://github.com/python/cpython/commit/ac811f9b5a68ce8756911ef2c8be83b46696018f
msg398843 - (view) Author: miss-islington (miss-islington) Date: 2021-08-03 17:48
New changeset f26fec4f74ae7da972595703bc39d3d30b8cfdf9 by Miss Islington (bot) in branch '3.9':
bpo-41886: Fix documented type of PyType_Type (GH-22454)
https://github.com/python/cpython/commit/f26fec4f74ae7da972595703bc39d3d30b8cfdf9
msg398844 - (view) Author: miss-islington (miss-islington) Date: 2021-08-03 17:50
New changeset 952aa31c89f70d3c53596449bd2ed9a4817a2364 by Miss Islington (bot) in branch '3.10':
bpo-41886: Fix documented type of PyType_Type (GH-22454)
https://github.com/python/cpython/commit/952aa31c89f70d3c53596449bd2ed9a4817a2364
msg398845 - (view) Author: Ammar Askar (ammar2) * (Python committer) Date: 2021-08-03 17:51
Thank you for spotting this and the patch da-woods!
History
Date User Action Args
2022-04-11 14:59:36adminsetgithub: 86052
2021-08-03 17:51:54ammar2setstatus: open -> closed
versions: + Python 3.9
type: behavior
messages: + msg398845

resolution: fixed
stage: patch review -> resolved
2021-08-03 17:50:33miss-islingtonsetmessages: + msg398844
2021-08-03 17:48:17miss-islingtonsetmessages: + msg398843
2021-08-03 17:26:06miss-islingtonsetpull_requests: + pull_request26087
2021-08-03 17:22:56miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request26086
2021-08-03 17:21:29ammar2setnosy: + ammar2
messages: + msg398841
2021-08-03 17:18:03ammar2setversions: + Python 3.11, - Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9
2020-09-29 21:06:24python-devsetkeywords: + patch
nosy: + python-dev

pull_requests: + pull_request21483
stage: patch review
2020-09-29 20:58:03da-woodscreate