diff options
| author |   Pablo Galindo <Pablogsal@gmail.com> | 2021-02-15 23:03:38 +0000 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2021-02-15 23:03:38 +0000 |
| commit | 813db24f7c2c536d587d1832c3c52b44fa9e242e (patch) | |
| tree | 508383e94d71c6e72e2c3bf1deb0fa1030a82e3d | |
| parent | bpo-43231: Correctly calculate the curses color pair limit when checking for ... (diff) | |
| download | cpython-813db24f7c2c536d587d1832c3c52b44fa9e242e.tar.gz cpython-813db24f7c2c536d587d1832c3c52b44fa9e242e.tar.bz2 cpython-813db24f7c2c536d587d1832c3c52b44fa9e242e.zip | |
Add a warning block around the get_referrers() documentation (GH-24511)
| -rw-r--r-- | Doc/library/gc.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst index 2d85cd34317..a3d201d5055 100644 --- a/Doc/library/gc.rst +++ b/Doc/library/gc.rst @@ -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) |