Skip to content

Commit

Permalink
📝 Make the changelog examples elaborate (#8113)
Browse files Browse the repository at this point in the history
This patch shows the use of sentences with full stops and it also
includes an excerpt with a paragraph, which demonstrates that it is
possible to include details extending shorter sentences.
  • Loading branch information
webknjaz authored Jan 30, 2024
1 parent 2d8ffdf commit 8b33fe6
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions CHANGES/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,21 +86,28 @@ File :file:`CHANGES/6045.doc.1.rst`:

.. code-block:: rst
Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`
Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`.
File :file:`CHANGES/4431.bugfix.rst`:
File :file:`CHANGES/8074.bugfix.rst`:

.. code-block:: rst
Fixed HTTP client requests to honor ``no_proxy`` environment
variables -- by :user:`scirelli`
Fixed an unhandled exception in the Python HTTP parser on header
lines starting with a colon -- by :user:`pajod`.
Invalid request lines with anything but a dot between the HTTP
major and minor version are now rejected. Invalid header field
names containing question mark or slash are now rejected. Such
requests are incompatible with :rfc:`9110#section-5.6.2` and are
not known to be of any legitimate use.
File :file:`CHANGES/4594.feature.rst`:

.. code-block:: rst
Added support for ``ETag`` to :py:class:`~aiohttp.web.FileResponse`
-- by :user:`greshilov`, :user:`serhiy-storchaka` and :user:`asvetlov`
-- by :user:`greshilov`, :user:`serhiy-storchaka` and
:user:`asvetlov`.
.. tip::

Expand Down

0 comments on commit 8b33fe6

Please sign in to comment.