gh-135913: Document ob_refcnt, ob_type, ob_size #135914
Conversation
bedevere-app
bot
added
awaiting core review
docs
| .. c:member:: Py_ssize_t ob_refcnt | ||
| The object's reference count, as returned by :c:macro:`Py_REFCNT`. | ||
| Do not use this field directly; instead use functions and macros such as | ||
| :c:macro:`!Py_REFCNT`, :c:func:`Py_INCREF` and :c:func:`Py_DecRef`. |
There was a problem hiding this comment.
I don't think this is accurate anymore:
Lines 128 to 146 in a88b49c
There was a problem hiding this comment.
Hm, yes, the type isn't Py_ssize_t any more.
That's an issue in the current documentation too; guess it's time to reopen #125174 for a docs update.
Similarly, a lot of the docs talk about PyObject_HEAD_INIT setting the refcount to 1. I can't fix everything in this PR...
There was a problem hiding this comment.
Sphinx needs a type for .. c:member:. I don't think I can do better than the note below.
There was a problem hiding this comment.
You may mention Py_SET_REFCNT() as well.
| .. c:member:: Py_ssize_t ob_refcnt | ||
| The object's reference count, as returned by :c:macro:`Py_REFCNT`. | ||
| Do not use this field directly; instead use functions and macros such as | ||
| :c:macro:`!Py_REFCNT`, :c:func:`Py_INCREF` and :c:func:`Py_DecRef`. |
There was a problem hiding this comment.
You may mention Py_SET_REFCNT() as well.
| A size field, whose contents should be considered an object's internal | ||
| implementation detail. | ||
|
|
||
| Do not use this field directly; use :c:macro:`Py_SIZE` instead. |
There was a problem hiding this comment.
Maybe mention Py_SET_SIZE() as well.
📚 Documentation preview 📚: https://cpython-previews--135914.org.readthedocs.build/