[Python-checkins] Add a warning block around the get_referrers() documentation (GH-24511) (GH-24544)
ned-deily
webhook-mailer at python.org
Mon Feb 15 19:58:13 EST 2021
https://github.com/python/cpython/commit/b61b20dba554a74a2f9f0936b16dd669f93a561c
commit: b61b20dba554a74a2f9f0936b16dd669f93a561c
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ned-deily <nad at python.org>
date: 2021-02-15T19:58:05-05:00
summary:
Add a warning block around the get_referrers() documentation (GH-24511) (GH-24544)
(cherry picked from commit 813db24f7c2c536d587d1832c3c52b44fa9e242e)
Co-authored-by: Pablo Galindo <Pablogsal at gmail.com>
files:
M Doc/library/gc.rst
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 1f09ed52ce867..7ee71dc446271 100644
--- a/Doc/library/gc.rst
+++ b/Doc/library/gc.rst
@@ -132,10 +132,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)
More information about the Python-checkins
mailing list