diff options
author | Jeff Forcier <jeff@bitprophet.org> | 2014-09-18 17:54:20 -0700 |
---|---|---|
committer | Jeff Forcier <jeff@bitprophet.org> | 2014-09-18 17:54:20 -0700 |
commit | 233f0a422e3384584e20eff7330a536230d3cd31 (patch) | |
tree | 03bf3c41eed120f22bf2e3c7c4eda22ab39f2fd9 /paramiko/file.py | |
parent | 17dbb6a48c0ccf645bc8a53d22ba502a71a99a26 (diff) | |
download | paramiko-233f0a422e3384584e20eff7330a536230d3cd31.tar.gz |
Fix more missed epydoc syntax
Diffstat (limited to 'paramiko/file.py')
-rw-r--r-- | paramiko/file.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/paramiko/file.py b/paramiko/file.py index 2238f0bf..0a7fbcba 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -104,14 +104,13 @@ class BufferedFile (object): else: def __next__(self): """ - Returns the next line from the input, or raises L{StopIteration} when + Returns the next line from the input, or raises `.StopIteration` when EOF is hit. Unlike python file objects, it's okay to mix calls to - C{next} and L{readline}. + `.next` and `.readline`. - @raise StopIteration: when the end of the file is reached. + :raises StopIteration: when the end of the file is reached. - @return: a line read from the file. - @rtype: str + :returns: a line (`str`) read from the file. """ line = self.readline() if not line: |