Skip to content

Add a warning block around the get_referrers() documentation #24511

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 2 commits into from
Feb 15, 2021
+5 −4
Merged

Add a warning block around the get_referrers() documentation #24511

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bcf0f3
Add a warning block around the get_referrers() documentation
pablogsal Feb 12, 2021
932f5c0
Update Doc/library/gc.rst
pablogsal Feb 15, 2021
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
9 changes: 5 additions & 4 deletions Doc/library/gc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,11 @@ The :mod:`gc` module provides the following functions:
resulting referrers. To get only currently live objects, call :func:`collect`
before calling :func:`get_referrers`.

Care must be taken when using objects returned by :func:`get_referrers` because
some of them could still be under construction and hence in a temporarily
invalid state. Avoid using :func:`get_referrers` for any purpose other than
debugging.
.. warning::
Care must be taken when using objects returned by :func:`get_referrers` because
some of them could still be under construction and hence in a temporarily
invalid state. Avoid using :func:`get_referrers` for any purpose other than
debugging.


.. function:: get_referents(*objs)
Expand Down