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: Refcounting information missing in docs for Python 3.4 and above.
Type: Stage: resolved
Components: Documentation Versions: Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, georg.brandl, mark.dickinson, python-dev, vstinner
Priority: normal Keywords:

Created on 2014-04-17 16:38 by mark.dickinson, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (4)
msg216707 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2014-04-17 16:38
It looks as though the information from refcounts.dat isn't making it into the online docs for 3.4 and 3.5.  See e.g., the documentation for PyList_GetItem.  For 3.3 [2], there's a "Return value: Borrowed reference." annotation supplied by Sphinx's refcounting extension.  For the 3.4 and 3.5 docs that annotation is missing.

Issue originally reported by Jianfeng Mao on the python-dev mailing list [1].

[1] https://mail.python.org/pipermail/python-dev/2014-April/134089.html
[2] https://docs.python.org/3.3/c-api/list.html?highlight=pylist_getitem#PyList_GetItem
msg216710 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2014-04-17 16:44
N.B.  When I build the docs locally on the default branch (using 'make html' from the Docs directory on a clean checkout), I *do* see the refcounting annotations in the html output.
msg216762 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-04-17 22:29
New changeset 8c12d3e0f1de by Benjamin Peterson in branch '3.4':
fix ref count annotations on sphinx >= 1.2.1 (closes #21286)
http://hg.python.org/cpython/rev/8c12d3e0f1de
msg216772 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2014-04-18 05:02
Thanks!
History
Date User Action Args
2022-04-11 14:58:02adminsetgithub: 65485
2014-04-18 05:02:25georg.brandlsetmessages: + msg216772
2014-04-17 22:29:34python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg216762

resolution: fixed
stage: resolved
2014-04-17 17:54:15ned.deilysetnosy: + georg.brandl
2014-04-17 16:44:23mark.dickinsonsetmessages: + msg216710
2014-04-17 16:40:45vstinnersetnosy: + vstinner
2014-04-17 16:38:54mark.dickinsoncreate