[Python-Dev] C API doc question (original) (raw)

Amaury Forgeot d'Arc amauryfa at gmail.com
Fri Sep 3 13:19:47 CEST 2010

2010/9/3 Nick Coghlan <ncoghlan at gmail.com>:

Due to the Unicode API discussion, I happened to be looking at the C API docs at http://docs.python.org/dev/c-api/unicode.html#plain-py-unicode and noticed that out of:

PyUnicodeFromUnicode PyUnicodeFromStringAndSize PyUnicodeFromString PyUnicodeFromFormat PyUnicodeFromFormatV PyUnicodeFromEncodedObject PyUnicodeFromObject only the first and the last two are flagged in the online docs as returning a new reference. The other 4 are not (but probably should be). However, I can't see anything in the markup which is even causing those "Return value: New reference" markings to appear in the first place, nor any clues in the Documenting Python info. What am I missing?

This information is in the file: Doc/data/refcounts.dat There is a extension to sphinx that reads this file and generates the annotation in the documentation. This file is not very well known, even by core developers...

-- Amaury Forgeot d'Arc

More information about the Python-Dev mailing list