diff options
| author | Sam Whited <sam@samwhited.com> | 2016-09-30 13:49:04 -0500 |
|---|---|---|
| committer | Sam Whited <sam@samwhited.com> | 2016-09-30 13:49:04 -0500 |
| commit | 8217dc5239f7a649702c498b7b8a18263b813339 (patch) | |
| tree | e2bedf7ff0ff66e618d004ce47e4b64e8f4defde | |
| parent | 2586abc0d36cbb8eae3540b5cb6d224c90b4b699 (diff) | |
| download | slixmpp-8217dc5239f7a649702c498b7b8a18263b813339.tar.gz slixmpp-8217dc5239f7a649702c498b7b8a18263b813339.tar.bz2 slixmpp-8217dc5239f7a649702c498b7b8a18263b813339.tar.xz slixmpp-8217dc5239f7a649702c498b7b8a18263b813339.zip | |
Minor documentation fixes
| -rw-r--r-- | slixmpp/clientxmpp.py | 7 | ||||
| -rw-r--r-- | slixmpp/xmlstream/xmlstream.py | 4 |
2 files changed, 7 insertions, 4 deletions
diff --git a/slixmpp/clientxmpp.py b/slixmpp/clientxmpp.py index 0971e304..a4bb9a60 100644 --- a/slixmpp/clientxmpp.py +++ b/slixmpp/clientxmpp.py @@ -141,8 +141,11 @@ class ClientXMPP(BaseXMPP): will be used. :param address: A tuple containing the server's host and port. - :param use_tls: Indicates if TLS should be used for the - connection. Defaults to ``True``. + :param force_starttls: Indicates that negotiation should be aborted + if the server does not advertise support for + STARTTLS. Defaults to ``True``. + :param disable_starttls: Disables TLS for the connection. + Defaults to ``False``. :param use_ssl: Indicates if the older SSL connection method should be used. Defaults to ``False``. """ diff --git a/slixmpp/xmlstream/xmlstream.py b/slixmpp/xmlstream/xmlstream.py index bd6c4e6f..686dfde8 100644 --- a/slixmpp/xmlstream/xmlstream.py +++ b/slixmpp/xmlstream/xmlstream.py @@ -256,9 +256,9 @@ class XMLStream(asyncio.BaseProtocol): TODO fix the comment :param force_starttls: If True, the connection will be aborted if the server does not initiate a STARTTLS - negociation. If None, the connection will be + negotiation. If None, the connection will be upgraded to TLS only if the server initiate - the STARTTLS negociation, otherwise it will + the STARTTLS negotiation, otherwise it will connect in clear. If False it will never upgrade to TLS, even if the server provides it. Use this for example if you’re on |