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

[PR #8403/06033c23 backport][3.10] Update docs for ssl param in client #8404

Conversation

patchback[bot]
Copy link
Contributor

@patchback patchback bot commented May 8, 2024

This is a backport of PR #8403 as merged into master (06033c2).

What do these changes do?

Improve the docs for the ssl params.

In the current docs, the following is written:

ssl
SSL validation mode. None for default SSL check

However, None is deprecated since #8048 and the default is actually True as shown in the code:

ssl: Union[SSLContext, bool, Fingerprint] = True

Are there changes in behavior for the user?

Just docs.

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

No.

Related issue number

No.

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

@patchback patchback bot requested review from webknjaz and asvetlov as code owners May 8, 2024 18:00
@patchback patchback bot mentioned this pull request May 8, 2024
5 tasks
Copy link

codecov bot commented May 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.45%. Comparing base (c215e56) to head (fa2f4af).

Additional details and impacted files
@@            Coverage Diff             @@
##             3.10    #8404      +/-   ##
==========================================
- Coverage   97.51%   97.45%   -0.07%     
==========================================
  Files         108      108              
  Lines       33285    33285              
  Branches     3997     3997              
==========================================
- Hits        32459    32437      -22     
- Misses        602      620      +18     
- Partials      224      228       +4     
Flag Coverage Δ
CI-GHA 97.37% <ø> (-0.06%) ⬇️
OS-Linux 97.04% <ø> (-0.06%) ⬇️
OS-Windows 94.69% <ø> (-0.01%) ⬇️
OS-macOS 96.76% <ø> (-0.01%) ⬇️
Py-3.10.11 96.87% <ø> (ø)
Py-3.10.14 96.84% <ø> (ø)
Py-3.11.9 97.06% <ø> (-0.01%) ⬇️
Py-3.12.3 96.88% <ø> (-0.30%) ⬇️
Py-3.8.10 ?
Py-3.8.18 96.73% <ø> (ø)
Py-3.9.13 96.87% <ø> (ø)
Py-3.9.19 96.84% <ø> (ø)
Py-pypy7.3.15 ?
VM-macos 96.76% <ø> (-0.01%) ⬇️
VM-ubuntu 97.04% <ø> (-0.06%) ⬇️
VM-windows 94.69% <ø> (-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.

@Dreamsorcerer Dreamsorcerer merged commit e839279 into 3.10 May 8, 2024
33 of 34 checks passed
@Dreamsorcerer Dreamsorcerer deleted the patchback/backports/3.10/06033c231c3ff28bd1a2046fe23029f4cacf1e44/pr-8403 branch May 8, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants