Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update docs for aiohttp.request #10301

Merged
merged 3 commits into from
Jan 7, 2025
Merged

Update docs for aiohttp.request #10301

merged 3 commits into from
Jan 7, 2025

Conversation

Cycloctane
Copy link
Member

What do these changes do?

Noticed that the content of aiohttp.request reference in documentation needs to be changed after #10300 . This pr update docs for that.

Are there changes in behavior for the user?

Is it a substantial burden for the maintainers to support this?

Related issue number

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Jan 6, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #10301 will not alter performance

Comparing Cycloctane:update_request_docs (dbce2cd) with master (3d06cc1)

Summary

✅ 47 untouched benchmarks

@codecov Codecov
Copy link

codecov bot commented Jan 6, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.77%. Comparing base (3d06cc1) to head (dbce2cd).
Report is 2 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #10301   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files         122      122           
  Lines       37038    37038           
  Branches     2041     2041           
=======================================
  Hits        36585    36585           
  Misses        314      314           
  Partials      139      139
Flag Coverage Δ
CI-GHA 98.66% <ø> (ø)
OS-Linux 98.35% <ø> (ø)
OS-Windows 96.25% <ø> (ø)
OS-macOS 97.47% <ø> (+<0.01%) ⬆️
Py-3.10.11 97.35% <ø> (ø)
Py-3.10.15 97.92% <ø> (ø)
Py-3.11.11 98.01% <ø> (ø)
Py-3.11.9 97.43% <ø> (ø)
Py-3.12.8 98.44% <ø> (ø)
Py-3.13.1 98.43% <ø> (ø)
Py-3.9.13 97.24% <ø> (ø)
Py-3.9.20 97.80% <ø> (ø)
Py-pypy7.3.16 97.39% <ø> (ø)
VM-macos 97.47% <ø> (+<0.01%) ⬆️
VM-ubuntu 98.35% <ø> (ø)
VM-windows 96.25% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jan 6, 2025
@Dreamsorcerer
Copy link
Member

Would probably make sense to just reference another function that has these documented, rather than duplicating them all...

@Dreamsorcerer Dreamsorcerer added bot:chronographer:skip This PR does not need to include a change note backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot labels Jan 6, 2025
@Dreamsorcerer Dreamsorcerer merged commit 77f25a0 into aio-libs:master Jan 7, 2025
43 checks passed
@patchback Patchback
Copy link
Contributor

patchback bot commented Jan 7, 2025 •
edited
Loading

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/77f25a0a4da3cc20f4c5b6d12be9d273ea02f1df/pr-10301

Backported as #10307

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jan 7, 2025
@Cycloctane @patchback
Update docs for aiohttp.request (#10301)
ec01e17 
(cherry picked from commit 77f25a0)
@patchback patchback bot mentioned this pull request Jan 7, 2025
Open
5 tasks
@patchback Patchback
Copy link
Contributor

patchback bot commented Jan 7, 2025 •
edited
Loading

Backport to 3.12: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.12/77f25a0a4da3cc20f4c5b6d12be9d273ea02f1df/pr-10301

Backported as #10308

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jan 7, 2025
@Cycloctane @patchback
Update docs for aiohttp.request (#10301)
58346e9 
(cherry picked from commit 77f25a0)
@patchback patchback bot mentioned this pull request Jan 7, 2025
Merged
5 tasks
Dreamsorcerer pushed a commit that referenced this pull request Jan 7, 2025
@patchback @Cycloctane
[PR #10301/77f25a0a backport][3.12] Update docs for aiohttp.request (#…
3d3a088 
…10308)

**This is a backport of PR #10301 as merged into master
(77f25a0).**

Co-authored-by: Cycloctane <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

Assignees
No one assigned
Labels
backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Cycloctane @Dreamsorcerer