summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2015-12-17 18:17:07 -0800
committerJeff Forcier <jeff@bitprophet.org>2015-12-17 18:17:07 -0800
commit5553764fed7ee81cb5efb1a0927389bf9706b322 (patch)
tree9a9ede61414111694dbb5a4aaec9c7ddfa2175bb
parent9a87a8eb599d2b3914a3f3fcedbea8b25ab33d5a (diff)
Tweak some off-spec or busted docstring bits
-rw-r--r--paramiko/file.py22
1 files changed, 11 insertions, 11 deletions
diff --git a/paramiko/file.py b/paramiko/file.py
index 43d1c008..3d0acc1c 100644
--- a/paramiko/file.py
+++ b/paramiko/file.py
@@ -123,9 +123,9 @@ class BufferedFile (ClosingContextManager):
"""
Check if the file can be read from.
- :return:
- `True` if the file can be read from. If `False`, :meth`read` will
- raise an exception
+ :returns:
+ `True` if the file can be read from. If `False`, `read` will raise
+ an exception.
"""
return (self._flags & self.FLAG_READ) == self.FLAG_READ
@@ -133,9 +133,9 @@ class BufferedFile (ClosingContextManager):
"""
Check if the file can be written to.
- :return:
- `True` if the file can be written to. If `False`, :meth:`write`
- will raise an exception
+ :returns:
+ `True` if the file can be written to. If `False`, `write` will
+ raise an exception.
"""
return (self._flags & self.FLAG_WRITE) == self.FLAG_WRITE
@@ -143,9 +143,9 @@ class BufferedFile (ClosingContextManager):
"""
Check if the file supports random access.
- :return:
- `True` if the file supports random access. If `False`,
- :meth:`seek` will raise an exception
+ :returns:
+ `True` if the file supports random access. If `False`, `seek` will
+ raise an exception.
"""
return False
@@ -154,8 +154,8 @@ class BufferedFile (ClosingContextManager):
Read up to ``len(buff)`` bytes into :class:`bytearray` *buff* and
return the number of bytes read.
- :return:
- the number of bytes read
+ :returns:
+ The number of bytes read.
"""
data = self.read(len(buff))
buff[:len(data)] = data