[issue9755] Fix refcounting details in Py3k C API documentation

[Fred L. Drake, Jr.]

Fred L. Drake, Jr. added the comment:

As mentioned in issue 18085, the original file was not generated, but crafted 
by hand (though I don't think that really matters).

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9755] Fix refcounting details in Py3k C API documentation

[Skip Montanaro]

Changes by Skip Montanaro :


--
nosy:  -skip.montanaro

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9755] Fix refcounting details in Py3k C API documentation

[Skip Montanaro]

Skip Montanaro  added the comment:

I thought Fred Drake wrote the code that generated that file, but that
was a long time ago in a galaxy far, far away.  Perhaps Georg has
subsumed it into his Sphinx/Python doc workflow?

(making Fred "nosy" so he sees this thread...)

S

--
nosy: +fdrake, skip.montanaro

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9755] Fix refcounting details in Py3k C API documentation

[Nick Coghlan]

Changes by Nick Coghlan :


--
assignee:  -> d...@python
nosy: +d...@python

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9755] Fix refcounting details in Py3k C API documentation

[Nick Coghlan]

New submission from Nick Coghlan :

As noted in [1] the refcount data for the C API documentation is contained in a 
separate file at Doc/data/refcounts.dat.

This file is not mentioned in "Documenting Python" and hence has not been 
correctly updated for Py3k (e.g. none of the PyString methods have been renamed 
to PyUnicode in that file, so the relevant refcount changes are not documented 
correctly).

There are several possible improvements to be considered in this area
1. Mention this file and its purpose in "Documenting Python"
2. Update the Sphinx extension to warn if a C API function is not found in this 
file
3. Update the Sphinx extension to allow this information to be expressed inline 
in the function definition rather than off in a separate file (if practical)
4. Address Skip's comment from that file by allowing "-0" to indicate stolen 
references for arguments and "+0" for borrowed references as return values
5. Perhaps add a mechanism to indicate when PyMem_Free needs to be called on a 
return value or pointer output value.

[1] http://mail.python.org/pipermail/python-dev/2010-September/103429.html

--
messages: 115441
nosy: ncoghlan
priority: normal
severity: normal
status: open
title: Fix refcounting details in Py3k C API documentation

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com