Changeset 1624:52b8ea2582cc


Ignore:
Timestamp:
Dec 23, 2015, 7:08:31 PM (5 years ago)
Author:
Stefan Schwarzer <sschwarzer@…>
Branch:
default
amend_source:
a4cfe2e0994625044ed86e3d08bd6ad85ff1b87c
Message:
Mention that `account` and `session_factory` normally aren't needed

Also changed the subsection heading from "Basics" to "Introduction"
since the use of `account` and `session_factory` aren't basic usage.

I considered but dismissed the idea of removing `account` and
`session_factory` from the initial usage example. In my opinion this
would "spread out" the description of the `FTPHost` constructor too
much.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/ftputil.txt

    r1623 r1624  
    310310~~~~~~~~~~~~
    311311
    312 Basics
    313 ``````
    314 
    315 ``FTPHost`` instances can be generated with the following call::
     312Introduction
     313````````````
     314
     315``FTPHost`` instances can be created with the following call::
    316316
    317317    ftp_host = ftputil.FTPHost(server, user, password, account,
     
    319319
    320320The first four parameters are strings with the same meaning as for the
    321 FTP class in the ``ftplib`` module.
     321FTP class in the ``ftplib`` module. Usually the ``account`` and
     322``session_factory`` arguments aren't needed though.
    322323
    323324``FTPHost`` objects can also be used in a ``with`` statement::
Note: See TracChangeset for help on using the changeset viewer.