diff options
author | Georg Brandl <georg@python.org> | 2009-06-08 09:13:45 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2009-06-08 09:13:45 (GMT) |
commit | cd7f32b6cd0dc03383319846e4c7962b4716e439 (patch) | |
tree | b455b6962e36ced3a77b5f7ab8e647df57c3b790 /Doc/library/linecache.rst | |
parent | cdf8b34b5164fb660c6d2554efb0bf45896c09e2 (diff) | |
download | cpython-cd7f32b6cd0dc03383319846e4c7962b4716e439.zip cpython-cd7f32b6cd0dc03383319846e4c7962b4716e439.tar.gz cpython-cd7f32b6cd0dc03383319846e4c7962b4716e439.tar.bz2 |
Signature documentation style update, modules J, K, L and M.
Diffstat (limited to 'Doc/library/linecache.rst')
-rw-r--r-- | Doc/library/linecache.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst index 1aef2f3..146cb27 100644 --- a/Doc/library/linecache.rst +++ b/Doc/library/linecache.rst @@ -1,4 +1,3 @@ - :mod:`linecache` --- Random access to text lines ================================================ @@ -15,7 +14,7 @@ to retrieve source lines for inclusion in the formatted traceback. The :mod:`linecache` module defines the following functions: -.. function:: getline(filename, lineno[, module_globals]) +.. function:: getline(filename, lineno, module_globals=None) Get line *lineno* from file named *filename*. This function will never throw an exception --- it will return ``''`` on errors (the terminating newline character @@ -35,12 +34,13 @@ The :mod:`linecache` module defines the following functions: previously read using :func:`getline`. -.. function:: checkcache([filename]) +.. function:: checkcache(filename=None) Check the cache for validity. Use this function if files in the cache may have changed on disk, and you require the updated version. If *filename* is omitted, it will check all the entries in the cache. + Example:: >>> import linecache |