]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-43225: [DOC] Add missing value returned by methods on cookiejar (GH-24522)
authorEmmanuel Arias <eamanu@yaerobi.com>
Mon, 15 Nov 2021 22:44:32 +0000 (19:44 -0300)
committerGitHub <noreply@github.com>
Mon, 15 Nov 2021 22:44:32 +0000 (14:44 -0800)
* Add missing value returned by methods on cookiejar

Documentation say that return something but don't specific with what
value is return, and that can be confuse. This patch add that information.

* Update Doc/library/http.cookiejar.rst

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
* Update Doc/library/http.cookiejar.rst

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
Doc/library/http.cookiejar.rst

index 3d59665be4f2540e281f3441cc507d1a821519f7..51a8c53152b0193b11aef14f84830454ab9aefbf 100644 (file)
@@ -494,7 +494,8 @@ and ``".168.1.2"``, 192.168.1.2 is blocked, but 193.168.1.2 is not.
 
 .. method:: DefaultCookiePolicy.is_blocked(domain)
 
-   Return whether *domain* is on the blocklist for setting or receiving cookies.
+   Return ``True`` if *domain* is on the blocklist for setting or receiving
+   cookies.
 
 
 .. method:: DefaultCookiePolicy.allowed_domains()
@@ -509,7 +510,7 @@ and ``".168.1.2"``, 192.168.1.2 is blocked, but 193.168.1.2 is not.
 
 .. method:: DefaultCookiePolicy.is_not_allowed(domain)
 
-   Return whether *domain* is not on the allowlist for setting or receiving
+   Return ``True`` if *domain* is not on the allowlist for setting or receiving
    cookies.
 
 :class:`DefaultCookiePolicy` instances have the following attributes, which are
@@ -766,4 +767,3 @@ returned::
    cj = CookieJar(policy)
    opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
    r = opener.open("http://example.com/")
-