Skip to content

Commit 118660a

Browse files
committed
Fix docs generation errors.
1 parent 947b81f commit 118660a

File tree

5 files changed

+14
-12
lines changed

5 files changed

+14
-12
lines changed

docs/howto/django.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,7 @@ starts. Typically, you would put it in a :download:`signals.py
231231

232232
.. literalinclude:: ../../example/django/signals.py
233233
:caption: signals.py
234+
234235
This code runs every time the admin saves a ``LogEntry`` object to keep track
235236
of a change. It extracts interesting data, serializes it to JSON, and writes
236237
an event to Redis.
@@ -267,6 +268,7 @@ Here's a complete implementation.
267268

268269
.. literalinclude:: ../../example/django/notifications.py
269270
:caption: notifications.py
271+
270272
Since the ``get_content_types()`` function makes a database query, it is
271273
wrapped inside :func:`asyncio.to_thread()`. It runs once when each WebSocket
272274
connection is open; then its result is cached for the lifetime of the

docs/reference/sync/client.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Using a connection
3939

4040
.. autoproperty:: remote_address
4141

42-
.. autoproperty:: latency
42+
.. autoattribute:: latency
4343

4444
.. autoproperty:: state
4545

docs/reference/sync/server.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Using a connection
6565

6666
.. autoproperty:: remote_address
6767

68-
.. autoproperty:: latency
68+
.. autoattribute:: latency
6969

7070
.. autoproperty:: state
7171

src/websockets/asyncio/router.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,12 @@ async def channel_handler(websocket, channel_id):
9090
when the server runs behind a reverse proxy that modifies the ``Host``
9191
header or terminates TLS, you need additional configuration:
9292
93-
* Set ``server_name`` to the name of the server as seen by clients. When not
94-
provided, websockets uses the value of the ``Host`` header.
93+
* Set ``server_name`` to the name of the server as seen by clients. When
94+
not provided, websockets uses the value of the ``Host`` header.
9595
96-
* Set ``ssl=True`` to generate ``wss://`` URIs without actually enabling
97-
TLS. Under the hood, this bind the URL map with a ``url_scheme`` of
98-
``wss://`` instead of ``ws://``.
96+
* Set ``ssl=True`` to generate ``wss://`` URIs without enabling TLS.
97+
Under the hood, this bind the URL map with a ``url_scheme`` of
98+
``wss://`` instead of ``ws://``.
9999
100100
There is no need to specify ``websocket=True`` in each rule. It is added
101101
automatically.

src/websockets/sync/router.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ def channel_handler(websocket, channel_id):
8686
when the server runs behind a reverse proxy that modifies the ``Host``
8787
header or terminates TLS, you need additional configuration:
8888
89-
* Set ``server_name`` to the name of the server as seen by clients. When not
90-
provided, websockets uses the value of the ``Host`` header.
89+
* Set ``server_name`` to the name of the server as seen by clients. When
90+
not provided, websockets uses the value of the ``Host`` header.
9191
92-
* Set ``ssl=True`` to generate ``wss://`` URIs without actually enabling
93-
TLS. Under the hood, this bind the URL map with a ``url_scheme`` of
94-
``wss://`` instead of ``ws://``.
92+
* Set ``ssl=True`` to generate ``wss://`` URIs without enabling TLS.
93+
Under the hood, this bind the URL map with a ``url_scheme`` of
94+
``wss://`` instead of ``ws://``.
9595
9696
There is no need to specify ``websocket=True`` in each rule. It is added
9797
automatically.

0 commit comments

Comments
 (0)