From: Yury Selivanov <yury@magic.io>
Date: Tue, 8 Nov 2016 17:23:09 +0000 (-0500)
Subject: docs/inspect: clarify iscoroutinefunction; add docs for isasyncgen*
X-Git-Tag: v3.6.0b4~130
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4778e13148ea8aa3c64fb264e2d03dbacc399991;p=thirdparty%2FPython%2Fcpython.git

docs/inspect: clarify iscoroutinefunction; add docs for isasyncgen*
---

diff --git a/Lib/inspect.py b/Lib/inspect.py
index 2923d6dacca0..f01dd1de5d67 100644
--- a/Lib/inspect.py
+++ b/Lib/inspect.py
@@ -179,17 +179,22 @@ def isgeneratorfunction(object):
 def iscoroutinefunction(object):
     """Return true if the object is a coroutine function.
 
-    Coroutine functions are defined with "async def" syntax,
-    or generators decorated with "types.coroutine".
+    Coroutine functions are defined with "async def" syntax.
     """
     return bool((isfunction(object) or ismethod(object)) and
                 object.__code__.co_flags & CO_COROUTINE)
 
 def isasyncgenfunction(object):
+    """Return true if the object is an asynchronous generator function.
+
+    Asynchronous generator functions are defined with "async def"
+    syntax and have "yield" expressions in their body.
+    """
     return bool((isfunction(object) or ismethod(object)) and
                 object.__code__.co_flags & CO_ASYNC_GENERATOR)
 
 def isasyncgen(object):
+    """Return true if the object is an asynchronous generator."""
     return isinstance(object, types.AsyncGeneratorType)
 
 def isgenerator(object):