Skip to content

Commit 96fddaf

Browse files
committed
Wording and line wrapping fixes in changelog.
1 parent 705dc85 commit 96fddaf

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/project/changelog.rst

+11-8
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ Backwards-incompatible changes
3434
..............................
3535

3636
.. admonition:: The ``ssl_context`` argument of :func:`~sync.client.connect`
37-
and :func:`~sync.server.serve` is renamed to ``ssl``.
37+
and :func:`~sync.server.serve` in the :mod:`threading` implementation is
38+
renamed to ``ssl``.
3839
:class: note
3940

4041
This aligns the API of the :mod:`threading` implementation with the
@@ -140,7 +141,8 @@ Backwards-incompatible changes
140141
As a consequence, calling ``WebSocket.close()`` without arguments in a
141142
browser isn't reported as an error anymore.
142143

143-
.. admonition:: :func:`~server.serve` times out on the opening handshake after 10 seconds by default.
144+
.. admonition:: :func:`~server.serve` times out on the opening handshake after
145+
10 seconds by default.
144146
:class: note
145147

146148
You can adjust the timeout with the ``open_timeout`` parameter. Set it to
@@ -149,7 +151,7 @@ Backwards-incompatible changes
149151
New features
150152
............
151153

152-
.. admonition:: websockets 11.0 introduces a implementation on top of :mod:`threading`.
154+
.. admonition:: websockets 11.0 introduces a :mod:`threading` implementation.
153155
:class: important
154156

155157
It may be more convenient if you don't need to manage many connections and
@@ -211,7 +213,8 @@ Improvements
211213
Backwards-incompatible changes
212214
..............................
213215

214-
.. admonition:: The ``exception`` attribute of :class:`~http11.Request` and :class:`~http11.Response` is deprecated.
216+
.. admonition:: The ``exception`` attribute of :class:`~http11.Request` and
217+
:class:`~http11.Response` is deprecated.
215218
:class: note
216219

217220
Use the ``handshake_exc`` attribute of :class:`~server.ServerProtocol` and
@@ -565,11 +568,11 @@ Backwards-incompatible changes
565568
.. admonition:: ``process_request`` is now expected to be a coroutine.
566569
:class: note
567570

568-
If you're passing a ``process_request`` argument to
569-
:func:`~server.serve` or :class:`~server.WebSocketServerProtocol`, or if
570-
you're overriding
571+
If you're passing a ``process_request`` argument to :func:`~server.serve`
572+
or :class:`~server.WebSocketServerProtocol`, or if you're overriding
571573
:meth:`~server.WebSocketServerProtocol.process_request` in a subclass,
572-
define it with ``async def`` instead of ``def``. Previously, both were supported.
574+
define it with ``async def`` instead of ``def``. Previously, both were
575+
supported.
573576

574577
For backwards compatibility, functions are still accepted, but mixing
575578
functions and coroutines won't work in some inheritance scenarios.

0 commit comments

Comments
 (0)