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.

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

Add missing docs for timeout parameter in WebSocketResponse.__init__() #9497

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

lenard-mosys
Copy link

What do these changes do?

Adds missing documentation.

Are there changes in behavior for the user?

No.

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

No

Related issue number

This was easier than opening an issue.

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
  • Add a new news fragment into the CHANGES/ folder

Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.59%. Comparing base (da0099d) to head (26b9e58).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9497   +/-   ##
=======================================
  Coverage   98.59%   98.59%           
=======================================
  Files         105      105           
  Lines       35093    35097    +4     
  Branches     4179     4179           
=======================================
+ Hits        34600    34604    +4     
  Misses        329      329           
  Partials      164      164           
Flag Coverage Δ
CI-GHA 98.47% <ø> (+<0.01%) ⬆️
OS-Linux 98.14% <ø> (+<0.01%) ⬆️
OS-Windows 96.53% <ø> (+<0.01%) ⬆️
OS-macOS 97.83% <ø> (+<0.01%) ⬆️
Py-3.10.11 97.70% <ø> (+<0.01%) ⬆️
Py-3.10.15 97.63% <ø> (+<0.01%) ⬆️
Py-3.11.10 97.70% <ø> (-0.01%) ⬇️
Py-3.11.9 97.78% <ø> (-0.01%) ⬇️
Py-3.12.7 98.19% <ø> (+<0.01%) ⬆️
Py-3.13.0 98.18% <ø> (+<0.01%) ⬆️
Py-3.9.13 97.60% <ø> (+<0.01%) ⬆️
Py-3.9.20 97.53% <ø> (+<0.01%) ⬆️
Py-pypy7.3.16 97.16% <ø> (+<0.01%) ⬆️
VM-macos 97.83% <ø> (+<0.01%) ⬆️
VM-ubuntu 98.14% <ø> (+<0.01%) ⬆️
VM-windows 96.53% <ø> (+<0.01%) ⬆️

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.

docs/web_reference.rst Outdated Show resolved Hide resolved
docs/web_reference.rst Outdated Show resolved Hide resolved
docs/web_reference.rst Outdated Show resolved Hide resolved
docs/web_reference.rst Outdated Show resolved Hide resolved
docs/web_reference.rst Outdated Show resolved Hide resolved
@Dreamsorcerer Dreamsorcerer added backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:skip This PR does not need to include a change note labels Oct 17, 2024
lenard-mosys and others added 5 commits October 18, 2024 09:47
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants