From 6436374ab06eaa80568d51f262cd92bcd9f6524a Mon Sep 17 00:00:00 2001 From: Vytautas Liuolia Date: Sun, 6 Oct 2024 15:51:08 +0200 Subject: [PATCH] docs(newsfragments): clean up newandimproved up to #2110 --- docs/_newsfragments/1947.newandimproved.rst | 8 ++++---- docs/_newsfragments/2023.newandimproved.rst | 2 +- docs/_newsfragments/228.newandimproved.rst | 6 ++++-- falcon/response.py | 5 ++--- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/_newsfragments/1947.newandimproved.rst b/docs/_newsfragments/1947.newandimproved.rst index 8ea9675c2..b52bbe539 100644 --- a/docs/_newsfragments/1947.newandimproved.rst +++ b/docs/_newsfragments/1947.newandimproved.rst @@ -1,4 +1,4 @@ -Basic typing annotations have been added to the most commonly used functions of -Falcon's public interface to the package itself in order to better support -`mypy `_ users without having to install any -third-party typeshed packages. +Type annotations have been added to Falcon's public interface to the package +itself in order to better support `Mypy `__ +(or other type checkers) users without having to install any third-party +typeshed packages. diff --git a/docs/_newsfragments/2023.newandimproved.rst b/docs/_newsfragments/2023.newandimproved.rst index b5001079c..baa31624d 100644 --- a/docs/_newsfragments/2023.newandimproved.rst +++ b/docs/_newsfragments/2023.newandimproved.rst @@ -1,4 +1,4 @@ The default error serializer will now use the response media handlers -to better negotiate the response serialization with the client. +to better negotiate the response content type with the client. The implementation still defaults to JSON if the client does not indicate any preference. diff --git a/docs/_newsfragments/228.newandimproved.rst b/docs/_newsfragments/228.newandimproved.rst index 5198a9d18..e76561191 100644 --- a/docs/_newsfragments/228.newandimproved.rst +++ b/docs/_newsfragments/228.newandimproved.rst @@ -1,2 +1,4 @@ -Add link-extension to :meth:`falcon.Response.append_link` as specified in -`RFC 8288 Sec. 3.4.2 `__. +A new keyword argument, `link_extension`, was added to +:meth:`falcon.Response.append_link` as specified in +`RFC 8288, Section 3.4.2 +`__. diff --git a/falcon/response.py b/falcon/response.py index 6bb6f7ee2..bd989868f 100644 --- a/falcon/response.py +++ b/falcon/response.py @@ -898,10 +898,9 @@ def append_link( Can take values 'anonymous' or 'use-credentials' or None. (See: https://www.w3.org/TR/html50/infrastructure.html#cors-settings-attribute) - link_extension(iterable): Provides additional custom attributes, as - described in RFC 8288, Section 3.4.2. Each member of the iterable + link_extension: Provides additional custom attributes, as + described in RFC 8288, Section 3.4.2; each member of the iterable must be a two-tuple in the form of (*param*, *value*). - (See: https://datatracker.ietf.org/doc/html/rfc8288#section-3.4.2) """