diff options
| author | Berker Peksag <berker.peksag@gmail.com> | 2017-03-17 11:59:16 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-17 11:59:16 (GMT) |
| commit | 948171bf999cf8b3e12048851041d2e04ae3a78c (patch) | |
| tree | 9765c22574c621846c1dc717b0fc73b09dd0b22f /Doc | |
| parent | 7c2081122c2a6b8ea27c3111da7f19f7824fe18a (diff) | |
| download | cpython-948171bf999cf8b3e12048851041d2e04ae3a78c.zip cpython-948171bf999cf8b3e12048851041d2e04ae3a78c.tar.gz cpython-948171bf999cf8b3e12048851041d2e04ae3a78c.tar.bz2 | |
bpo-16355: Clarify when inspect.getcomments() returns None (#428) (#690)
Initial patch by Vajrasky Kok.
(cherry picked from commit 3f2155ffe683080f2a1b28408fa48d43ba92f943)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/inspect.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index 3fa44a0..4ff2187 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -442,7 +442,9 @@ Retrieving source code Return in a single string any lines of comments immediately preceding the object's source code (for a class, function, or method), or at the top of the - Python source file (if the object is a module). + Python source file (if the object is a module). If the object's source code + is unavailable, return ``None``. This could happen if the object has been + defined in C or the interactive shell. .. function:: getfile(object) |