summaryrefslogtreecommitdiff
path: root/paramiko/file.py
diff options
context:
space:
mode:
authorJeremy T. Bouse <jbouse@debian.org>2014-09-22 20:57:20 -0400
committerJeremy T. Bouse <jbouse@debian.org>2014-09-22 20:57:20 -0400
commit941814e1efaf9a46992476e50badcecbcbfc9a41 (patch)
tree5105110a2b87bcf58340c7fa069220e673d90cc9 /paramiko/file.py
parentccd643cdbd7ba752727d62051058a4454451414d (diff)
downloadpython-paramiko-upstream/1.15.1.tar
python-paramiko-upstream/1.15.1.tar.gz
Imported Upstream version 1.15.1upstream/1.15.1
Diffstat (limited to 'paramiko/file.py')
-rw-r--r--paramiko/file.py9
1 files changed, 4 insertions, 5 deletions
diff --git a/paramiko/file.py b/paramiko/file.py
index 0999882..311e198 100644
--- a/paramiko/file.py
+++ b/paramiko/file.py
@@ -106,14 +106,13 @@ class BufferedFile (ClosingContextManager):
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: