~sschwarzer/ftputil: Mention that `account` and `session_factory` normally aren't needed

c6d0136bf66260c302304a9c53848e08337d405d — Stefan Schwarzer 7 years ago ca4dd62

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.

patch browse .tar.gz

1 files changed, 5 insertions(+), 4 deletions(-)

M doc/ftputil.txt

M doc/ftputil.txt => doc/ftputil.txt +5 -4

@@ 309,16 309,17 @@ encoding.
 Construction
 ~~~~~~~~~~~~
 
-Basics
-``````
+Introduction
+````````````
 
-``FTPHost`` instances can be generated with the following call::
+``FTPHost`` instances can be created with the following call::
 
     ftp_host = ftputil.FTPHost(server, user, password, account,
                                session_factory=ftplib.FTP)
 
 The first four parameters are strings with the same meaning as for the
-FTP class in the ``ftplib`` module.
+FTP class in the ``ftplib`` module. Usually the ``account`` and
+``session_factory`` arguments aren't needed though.
 
 ``FTPHost`` objects can also be used in a ``with`` statement::