Merge pull request gevent#1859 from aathan/master

Improved documentation of link() and rawlink()
th0114nd · Jan 20, 2022 · 5858d22 · 5858d22
2 parents ae2cb5a + f455557
commit 5858d22
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/gevent/greenlet.py b/src/gevent/greenlet.py
@@ -948,6 +948,9 @@ def rawlink(self, callback):
         The *callback* will be called with this instance as an
         argument.
 
+        The *callback* will be called even if linked after the greenlet
+        is already ready().
+
         .. caution::
             The *callback* will be called in the hub and
             **MUST NOT** raise an exception.
@@ -967,6 +970,9 @@ def link(self, callback, SpawnedLink=SpawnedLink):
         argument once this greenlet is dead. A callable is called in
         its own :class:`greenlet.greenlet` (*not* a
         :class:`Greenlet`).
+
+        The *callback* will be called even if linked after the greenlet
+        is already ready().
         """
         # XXX: Is the redefinition of SpawnedLink supposed to just be an
         # optimization, or do people use it? It's not documented