diff options
| author | Victor Stinner <vstinner@python.org> | 2020-11-09 12:40:47 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-09 12:40:47 (GMT) |
| commit | 23c5f93b83f78f295313e137011edb18b24c37c2 (patch) | |
| tree | 38cc104221c9e283bdb81f9511abe4fced97d67d /Doc/c-api/arg.rst | |
| parent | a117167d8dc8fa673a4646f509551c7950f824e5 (diff) | |
| download | cpython-23c5f93b83f78f295313e137011edb18b24c37c2.zip cpython-23c5f93b83f78f295313e137011edb18b24c37c2.tar.gz cpython-23c5f93b83f78f295313e137011edb18b24c37c2.tar.bz2 | |
bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206)
Add "borrowed reference" and "strong reference" to the documentation
glossary.
Enhance also Py_INCREF() and Py_NewRef() documentation.
Diffstat (limited to 'Doc/c-api/arg.rst')
| -rw-r--r-- | Doc/c-api/arg.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index bdaae44..a91b3c7 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -482,7 +482,8 @@ API Functions *min* and no more than *max*; *min* and *max* may be equal. Additional arguments must be passed to the function, each of which should be a pointer to a :c:type:`PyObject*` variable; these will be filled in with the values from - *args*; they will contain borrowed references. The variables which correspond + *args*; they will contain :term:`borrowed references <borrowed reference>`. + The variables which correspond to optional parameters not given by *args* will not be filled in; these should be initialized by the caller. This function returns true on success and false if *args* is not a tuple or contains the wrong number of elements; an exception |