[Python-checkins] bpo-43225: [DOC] Add missing value returned by methods on cookiejar (GH-24522)

willingc webhook-mailer at python.org
Mon Nov 15 17:44:38 EST 2021


https://github.com/python/cpython/commit/3352834f59531dfa42dbef00ada4fb95ded2ae3a
commit: 3352834f59531dfa42dbef00ada4fb95ded2ae3a
branch: main
author: Emmanuel Arias <eamanu at yaerobi.com>
committer: willingc <carolcode at willingconsulting.com>
date: 2021-11-15T14:44:32-08:00
summary:

bpo-43225: [DOC] Add missing value returned by methods on cookiejar (GH-24522)

* 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 at gmail.com>

* Update Doc/library/http.cookiejar.rst

Co-authored-by: andrei kulakov <andrei.avk at gmail.com>

Co-authored-by: andrei kulakov <andrei.avk at gmail.com>

files:
M Doc/library/http.cookiejar.rst

diff --git a/Doc/library/http.cookiejar.rst b/Doc/library/http.cookiejar.rst
index 3d59665be4f25..51a8c53152b01 100644
--- a/Doc/library/http.cookiejar.rst
+++ b/Doc/library/http.cookiejar.rst
@@ -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/")
-



More information about the Python-checkins mailing list