Skip to content
This repository was archived by the owner on Jan 13, 2021. It is now read-only.

Commit e56b343

Browse files
committed
Ensure the constructor is documented.
1 parent db5f541 commit e56b343

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

hyper/http20/connection.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,25 @@ class HTTP20Connection(object):
2626
2727
This object behaves similarly to the Python standard library's
2828
HTTPConnection object, with a few critical differences.
29+
30+
Most of the standard library's arguments to the constructor are irrelevant
31+
for HTTP/2.0 or not supported by hyper.
32+
33+
:param host: The host to connect to. This may be an IP address or a
34+
hostname, and optionally may include a port: for example,
35+
``'twitter.com'``, ``'twitter.com:443'`` or ``'127.0.0.1'``.
36+
:param port: (optional) The port to connect to. If not provided and one also
37+
isn't provided in the ``host`` parameter, defaults to 443.
38+
:param window_manager: (optional) The class to use to manage flow control
39+
windows. This needs to be a subclass of the
40+
:class:`BaseFlowControlManager <hyper.http20.window.BaseFlowControlManager>.
41+
If not provided,
42+
:class:`FlowControlManager <hyper.http20.window.FlowControlManager>`
43+
will be used.
2944
"""
3045
def __init__(self, host, port=None, *, window_manager=None, **kwargs):
3146
"""
3247
Creates an HTTP/2.0 connection to a specific server.
33-
34-
Most of the standard library's arguments to the constructor are
35-
irrelevant for HTTP/2.0 or not supported by hyper.
36-
37-
:param host: The host to connect to. This may be an IP address or a
38-
hostname, and optionally may include a port: for example,
39-
``'twitter.com'``, ``'twitter.com:443'`` or ``'127.0.0.1'``.
40-
:param port: (optional) The port to connect to. If not provided and one
41-
also isn't provided in the ``host`` parameter, defaults to 443.
42-
:param window_manager: (optional) The class to use to manage flow
43-
control windows. This needs to be a subclass of the
44-
:class:`BaseFlowControlManager <hyper.http20.window.BaseFlowControlManager>.
45-
If not provided,
46-
:class:`FlowControlManager <hyper.http20.window.FlowControlManager>`
47-
will be used.
4848
"""
4949
if port is None:
5050
try:

0 commit comments

Comments
 (0)