[New-bugs-announce] [issue44435] There is no description of PY_SSIZE_T_CLEAN in docs

[Jack DeVries]

New submission from Jack DeVries <jdevries3133 at gmail.com>:

In the intro to the C API (https://docs.python.org/3/c-api/intro.html#include-files), it says, "see Parsing arguments and building values for a description of this macro." There is a link which leads to ``arg.rst``, but there is no description of the macro there, just a note to include the macro like elsewhere.

I propose to remove this sentence from the docs, since it is my understanding that there is no need to document the details of why this macro must be defined, only to ensure that users define it.

Alternatively, add a description of the macro in the appropriate place in the C API docs, and fix the link in this blurb.

I'm happy to submit a documentation patch, but I'd need someone to advise on which of these options are more desired.

----------
messages: 395935
nosy: jack__d
priority: normal
severity: normal
status: open
title: There is no description of PY_SSIZE_T_CLEAN in docs

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue44435>
_______________________________________