-
-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docs on request cookies #5725
Conversation
So it matches what is actually used in the code See https://github.com/aio-libs/aiohttp/blob/63eb6ff550b2ba9f13cf5248980a4958e14a1af7/aiohttp/web_request.py#L565-L573
I did my best on wording, but I'm not normally a documentation writer 😊 |
This comment has been minimized.
This comment has been minimized.
|
||
Read-only :class:`~multidict.MultiDictProxy` lazy property. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to have an intersphinx reference to the actual type in the CPython docs. https://webknjaz.github.io/intersphinx-untangled/docs.python.org should help you construct it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Should be fixed by 767f6f5
Backport to 3.8: 💚 backport PR created✅ Backport PR branch: Backported as #5735 🤖 @patchback |
* Update docs on request cookies So it matches what is actually used in the code See https://github.com/aio-libs/aiohttp/blob/63eb6ff550b2ba9f13cf5248980a4958e14a1af7/aiohttp/web_request.py#L565-L573 * Add docs reference for request.cookies type (cherry picked from commit 4f48e3f)
* Update docs on request cookies So it matches what is actually used in the code See https://github.com/aio-libs/aiohttp/blob/63eb6ff550b2ba9f13cf5248980a4958e14a1af7/aiohttp/web_request.py#L565-L573 * Add docs reference for request.cookies type (cherry picked from commit 4f48e3f) Co-authored-by: Rasmus Wriedt Larsen <rasmuswriedtlarsen@gmail.com>
What do these changes do?
Update docs on request cookies type, so it matches what is actually used in the code
aiohttp/aiohttp/web_request.py
Lines 565 to 573 in 63eb6ff
Are there changes in behavior for the user?
No
Related issue number
No (I searched, but did not find any)
Checklist
CONTRIBUTORS.txt
: N/ACHANGES
folder<issue_id>.<type>
for example (588.bugfix)issue_id
change it to the pr id after creating the pr.feature
: Signifying a new feature..bugfix
: Signifying a bug fix..doc
: Signifying a documentation improvement..removal
: Signifying a deprecation or removal of public API..misc
: A ticket has been closed, but it is not of interest to users.