summaryrefslogtreecommitdiffstats
path: root/Objects/object.c
diff options
context:
space:
mode:
authorMark Shannon <mark@hotpy.org>2022-08-09 13:26:37 (GMT)
committerGitHub <noreply@github.com>2022-08-09 13:26:37 (GMT)
commit8d37c62c2a2579ae7839ecaf8351e862f2ecc9bb (patch)
tree17dfb0a52cdeb4da979d2b43fbe5c4beee832a4f /Objects/object.c
parenteb81c1aea16914347919745e843c982ed831a9fb (diff)
downloadcpython-8d37c62c2a2579ae7839ecaf8351e862f2ecc9bb.zip
cpython-8d37c62c2a2579ae7839ecaf8351e862f2ecc9bb.tar.gz
cpython-8d37c62c2a2579ae7839ecaf8351e862f2ecc9bb.tar.bz2
GH-92678: Document that you shouldn't be doing your own dictionary offset calculations. (GH-95598)
Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Diffstat (limited to 'Objects/object.c')
-rw-r--r--Objects/object.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/Objects/object.c b/Objects/object.c
index f0c0434..a90c6fa 100644
--- a/Objects/object.c
+++ b/Objects/object.c
@@ -1079,7 +1079,11 @@ _PyObject_ComputedDictPointer(PyObject *obj)
/* Helper to get a pointer to an object's __dict__ slot, if any.
* Creates the dict from inline attributes if necessary.
- * Does not set an exception. */
+ * Does not set an exception.
+ *
+ * Note that the tp_dictoffset docs used to recommend this function,
+ * so it should be treated as part of the public API.
+ */
PyObject **
_PyObject_GetDictPtr(PyObject *obj)
{