Skip to content

Commit 476aaac

Browse files
aaugustinaaugustin
committed
Deindent module contents in API docs.
This the dominant style in the project.
1 parent 281a5b3 commit 476aaac

File tree

3 files changed

+65
-66
lines changed

3 files changed

+65
-66
lines changed

‎docs/reference/datastructures.rst

+38-38
Original file line numberDiff line numberDiff line change
@@ -6,61 +6,61 @@ WebSocket events
66

77
.. automodule:: websockets.frames
88

9-
.. autoclass:: Frame
10-
11-
.. autoclass:: Opcode
12-
13-
.. autoattribute:: CONT
14-
.. autoattribute:: TEXT
15-
.. autoattribute:: BINARY
16-
.. autoattribute:: CLOSE
17-
.. autoattribute:: PING
18-
.. autoattribute:: PONG
19-
20-
.. autoclass:: Close
21-
22-
.. autoclass:: CloseCode
23-
24-
.. autoattribute:: NORMAL_CLOSURE
25-
.. autoattribute:: GOING_AWAY
26-
.. autoattribute:: PROTOCOL_ERROR
27-
.. autoattribute:: UNSUPPORTED_DATA
28-
.. autoattribute:: NO_STATUS_RCVD
29-
.. autoattribute:: ABNORMAL_CLOSURE
30-
.. autoattribute:: INVALID_DATA
31-
.. autoattribute:: POLICY_VIOLATION
32-
.. autoattribute:: MESSAGE_TOO_BIG
33-
.. autoattribute:: MANDATORY_EXTENSION
34-
.. autoattribute:: INTERNAL_ERROR
35-
.. autoattribute:: SERVICE_RESTART
36-
.. autoattribute:: TRY_AGAIN_LATER
37-
.. autoattribute:: BAD_GATEWAY
38-
.. autoattribute:: TLS_HANDSHAKE
9+
.. autoclass:: Frame
10+
11+
.. autoclass:: Opcode
12+
13+
.. autoattribute:: CONT
14+
.. autoattribute:: TEXT
15+
.. autoattribute:: BINARY
16+
.. autoattribute:: CLOSE
17+
.. autoattribute:: PING
18+
.. autoattribute:: PONG
19+
20+
.. autoclass:: Close
21+
22+
.. autoclass:: CloseCode
23+
24+
.. autoattribute:: NORMAL_CLOSURE
25+
.. autoattribute:: GOING_AWAY
26+
.. autoattribute:: PROTOCOL_ERROR
27+
.. autoattribute:: UNSUPPORTED_DATA
28+
.. autoattribute:: NO_STATUS_RCVD
29+
.. autoattribute:: ABNORMAL_CLOSURE
30+
.. autoattribute:: INVALID_DATA
31+
.. autoattribute:: POLICY_VIOLATION
32+
.. autoattribute:: MESSAGE_TOO_BIG
33+
.. autoattribute:: MANDATORY_EXTENSION
34+
.. autoattribute:: INTERNAL_ERROR
35+
.. autoattribute:: SERVICE_RESTART
36+
.. autoattribute:: TRY_AGAIN_LATER
37+
.. autoattribute:: BAD_GATEWAY
38+
.. autoattribute:: TLS_HANDSHAKE
3939

4040
HTTP events
4141
-----------
4242

4343
.. automodule:: websockets.http11
4444

45-
.. autoclass:: Request
45+
.. autoclass:: Request
4646

47-
.. autoclass:: Response
47+
.. autoclass:: Response
4848

4949
.. automodule:: websockets.datastructures
5050

51-
.. autoclass:: Headers
51+
.. autoclass:: Headers
5252

53-
.. automethod:: get_all
53+
.. automethod:: get_all
5454

55-
.. automethod:: raw_items
55+
.. automethod:: raw_items
5656

57-
.. autoexception:: MultipleValuesError
57+
.. autoexception:: MultipleValuesError
5858

5959
URIs
6060
----
6161

6262
.. automodule:: websockets.uri
6363

64-
.. autofunction:: parse_uri
64+
.. autofunction:: parse_uri
6565

66-
.. autoclass:: WebSocketURI
66+
.. autoclass:: WebSocketURI

‎docs/reference/extensions.rst

+20-21
Original file line numberDiff line numberDiff line change
@@ -16,45 +16,44 @@ Per-Message Deflate
1616

1717
.. automodule:: websockets.extensions.permessage_deflate
1818

19-
:mod:`websockets.extensions.permessage_deflate` implements WebSocket
20-
Per-Message Deflate.
19+
:mod:`websockets.extensions.permessage_deflate` implements WebSocket Per-Message
20+
Deflate.
2121

22-
This extension is specified in :rfc:`7692`.
22+
This extension is specified in :rfc:`7692`.
2323

24-
Refer to the :doc:`topic guide on compression <../topics/compression>` to
25-
learn more about tuning compression settings.
24+
Refer to the :doc:`topic guide on compression <../topics/compression>` to learn
25+
more about tuning compression settings.
2626

27-
.. autoclass:: ClientPerMessageDeflateFactory
27+
.. autoclass:: ServerPerMessageDeflateFactory
2828

29-
.. autoclass:: ServerPerMessageDeflateFactory
29+
.. autoclass:: ClientPerMessageDeflateFactory
3030

3131
Base classes
3232
------------
3333

3434
.. automodule:: websockets.extensions
3535

36-
:mod:`websockets.extensions` defines base classes for implementing
37-
extensions.
36+
:mod:`websockets.extensions` defines base classes for implementing extensions.
3837

39-
Refer to the :doc:`how-to guide on extensions <../howto/extensions>` to
40-
learn more about writing an extension.
38+
Refer to the :doc:`how-to guide on extensions <../howto/extensions>` to learn
39+
more about writing an extension.
4140

42-
.. autoclass:: Extension
41+
.. autoclass:: Extension
4342

44-
.. autoattribute:: name
43+
.. autoattribute:: name
4544

46-
.. automethod:: decode
45+
.. automethod:: decode
4746

48-
.. automethod:: encode
47+
.. automethod:: encode
4948

50-
.. autoclass:: ClientExtensionFactory
49+
.. autoclass:: ServerExtensionFactory
5150

52-
.. autoattribute:: name
51+
.. automethod:: process_request_params
5352

54-
.. automethod:: get_request_params
53+
.. autoclass:: ClientExtensionFactory
5554

56-
.. automethod:: process_response_params
55+
.. autoattribute:: name
5756

58-
.. autoclass:: ServerExtensionFactory
57+
.. automethod:: get_request_params
5958

60-
.. automethod:: process_request_params
59+
.. automethod:: process_response_params

‎docs/reference/types.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ Types
33

44
.. automodule:: websockets.typing
55

6-
.. autodata:: Data
6+
.. autodata:: Data
77

8-
.. autodata:: LoggerLike
8+
.. autodata:: LoggerLike
99

10-
.. autodata:: StatusLike
10+
.. autodata:: StatusLike
1111

12-
.. autodata:: Origin
12+
.. autodata:: Origin
1313

14-
.. autodata:: Subprotocol
14+
.. autodata:: Subprotocol
1515

16-
.. autodata:: ExtensionName
16+
.. autodata:: ExtensionName
1717

18-
.. autodata:: ExtensionParameter
18+
.. autodata:: ExtensionParameter
1919

2020
.. autodata:: websockets.protocol.Event
2121

0 commit comments

Comments
 (0)