Skip to content

Commit 4ec14c2

Browse files
authored
fix parameter names in ftplib documentation (GH-656)
1 parent ee10fb9 commit 4ec14c2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Doc/library/ftplib.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -243,17 +243,17 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
243243
the trailing CRLF stripped. The default *callback* prints the line to ``sys.stdout``.
244244

245245

246-
.. method:: FTP.set_pasv(boolean)
246+
.. method:: FTP.set_pasv(val)
247247

248-
Enable "passive" mode if *boolean* is true, other disable passive mode. (In
248+
Enable "passive" mode if *val* is true, otherwise disable passive mode. (In
249249
Python 2.0 and before, passive mode was off by default; in Python 2.1 and later,
250250
it is on by default.)
251251

252252

253-
.. method:: FTP.storbinary(command, file[, blocksize, callback, rest])
253+
.. method:: FTP.storbinary(command, fp[, blocksize, callback, rest])
254254

255255
Store a file in binary transfer mode. *command* should be an appropriate
256-
``STOR`` command: ``"STOR filename"``. *file* is an open file object which is
256+
``STOR`` command: ``"STOR filename"``. *fp* is an open file object which is
257257
read until EOF using its :meth:`read` method in blocks of size *blocksize* to
258258
provide the data to be stored. The *blocksize* argument defaults to 8192.
259259
*callback* is an optional single parameter callable that is called
@@ -269,11 +269,11 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
269269
.. versionchanged:: 2.7
270270
*rest* parameter added.
271271

272-
.. method:: FTP.storlines(command, file[, callback])
272+
.. method:: FTP.storlines(command, fp[, callback])
273273

274274
Store a file in ASCII transfer mode. *command* should be an appropriate
275275
``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the
276-
open file object *file* using its :meth:`~file.readline` method to provide
276+
open file object *fp* using its :meth:`~file.readline` method to provide
277277
the data to be stored. *callback* is an optional single parameter callable
278278
that is called on each line after it is sent.
279279

0 commit comments

Comments
 (0)