8000 gh-98154: Clarify Usage of "Reference Count" In the Docs by ericsnowcurrently · Pull Request #107552 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-98154: Clarify Usage of "Reference Count" In the Docs #107552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Aug 7, 2023
Merged

gh-98154: Clarify Usage of "Reference Count" In the Docs #107552

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0558e37
Update the refcounting doc.
ericsnowcurrently Aug 1, 2023
9c09e9e
Update the C-API intro doc.
ericsnowcurrently Aug 1, 2023
5fc8ee7
Add a note to the sys docs.
ericsnowcurrently Aug 1, 2023
71f3231
Update the glossary.
ericsnowcurrently Aug 1, 2023
991f9e9
Update the allocation doc.
ericsnowcurrently Aug 1, 2023
4322c2f
Update the "arg" doc.
ericsnowcurrently Aug 1, 2023
cbd7e23
Update the buffer docs.
ericsnowcurrently Aug 1, 2023
61580b9
Update the bytes doc.
ericsnowcurrently Aug 1, 2023
91acdc6
Update the exceptions doc.
ericsnowcurrently Aug 1, 2023
5f838eb
Update the init config doc.
ericsnowcurrently Aug 1, 2023
a013165
Update the module doc.
ericsnowcurrently Aug 1, 2023
b73734e
Update the object doc.
ericsnowcurrently Aug 1, 2023
d5804c7
Update the C-API sys doc.
ericsnowcurrently Aug 1, 2023
89f96fa
Update the typeobj doc.
ericsnowcurrently Aug 1, 2023
0109c12
Update the unicode doc.
ericsnowcurrently Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update the unicode doc.
  • Loading branch information
@ericsnowcurrently
ericsnowcurrently committed Aug 1, 2023
commit 0109c1207d72f36dba39246ac70f185e741a73ee
12 changes: 6 additions & 6 deletions Doc/c-api/unicode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ APIs:

Copy an instance of a Unicode subtype to a new true Unicode object if
necessary. If *obj* is already a true Unicode object (not a subtype),
return the reference with incremented refcount.
return a new :term:`strong reference` to the object.

Objects other than Unicode or its subtypes will cause a :exc:`TypeError`.

Expand Down Expand Up @@ -1438,11 +1438,11 @@ They all return ``NULL`` or ``-1`` if an exception occurs.
Intern the argument *\*string* in place. The argument must be the address of a
pointer variable pointing to a Python Unicode string object. If there is an
existing interned string that is the same as *\*string*, it sets *\*string* to
it (decrementing the reference count of the old string object and incrementing
the reference count of the interned string object), otherwise it leaves
*\*string* alone and interns it (incrementing its reference count).
(Clarification: even though there is a lot of talk about reference counts, think
of this function as reference-count-neutral; you own the object after the call
it (releasing the reference to the old string object and creating a new
:term:`strong reference` to the interned string object), otherwise it leaves
*\*string* alone and interns it (creating a new :term:`strong reference`).
(Clarification: even though there is a lot of talk about references, think
of this function as reference-neutral; you own the object after the call
if and only if you owned it before the call.)


Expand Down
0