Skip to content

[2.7] fix parameter names in ftplib documentation #656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhangyangyu merged 1 commit into from
Mar 13, 2017
Merged

[2.7] fix parameter names in ftplib documentation #656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Doc/library/ftplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,17 +243,17 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
the trailing CRLF stripped. The default *callback* prints the line to ``sys.stdout``.


.. method:: FTP.set_pasv(boolean)
.. method:: FTP.set_pasv(val)

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


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

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

.. method:: FTP.storlines(command, file[, callback])
.. method:: FTP.storlines(command, fp[, callback])

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

Expand Down