Skip to content

[docs] Fix grammar in ssl.SSLContect.sslsocket_class docstring #137935

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

Merged
merged 3 commits into from
Aug 19, 2025

Conversation

PrinceNaroliya
Copy link
Contributor

@PrinceNaroliya PrinceNaroliya commented Aug 19, 2025

Summary

Fixes a grammatical issue in the documentation for ssl.SSLContext.sslsocket_class.

Before

The return type of :meth:SSLContext.wrap_socket, defaults to
:class:SSLSocket. The attribute can be overridden on instance of class
in order to return a custom subclass of :class:SSLSocket.

After

The return type of :meth:SSLContext.wrap_socket, defaults to
:class:SSLSocket. The attribute can be assigned to on instances of
:class:SSLContext or overridden on subclasses of :class:SSLContext
in order to return a custom subclass of :class:SSLSocket.

Why

  • Corrects unclear grammar (“overridden on instance of class”).
  • Improves technical clarity by explicitly mentioning instances and subclasses.
  • Keeps consistency with the rest of the ssl docs.

Notes

  • Documentation-only change; no runtime behavior is affected.

Refs #103723


📚 Documentation preview 📚: https://cpython-previews--137935.org.readthedocs.build/

@python-cla-bot
Copy link

python-cla-bot bot commented Aug 19, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Aug 19, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Aug 19, 2025
@PrinceNaroliya PrinceNaroliya changed the title [docs] Fic grammar in ssl.SSLContect.sslsocket_class docstring [docs] Fix grammar in ssl.SSLContect.sslsocket_class docstring Aug 19, 2025
@gpshead gpshead added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Aug 19, 2025
@gpshead gpshead enabled auto-merge (squash) August 19, 2025 11:55
@gpshead gpshead merged commit 379161d into python:main Aug 19, 2025
31 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Aug 19, 2025
@miss-islington-app
Copy link

Thanks @PrinceNaroliya for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 19, 2025
…pythonGH-137935)

Fix grammar in ssl.SSLContect.sslsocket_class docstring

---------
(cherry picked from commit 379161d)

Co-authored-by: PrinceNaroliya <[email protected]>
Co-authored-by: Gregory P. Smith <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 19, 2025
…pythonGH-137935)

Fix grammar in ssl.SSLContect.sslsocket_class docstring

---------
(cherry picked from commit 379161d)

Co-authored-by: PrinceNaroliya <[email protected]>
Co-authored-by: Gregory P. Smith <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Aug 19, 2025

GH-137950 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Aug 19, 2025
@bedevere-app
Copy link

bedevere-app bot commented Aug 19, 2025

GH-137951 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Aug 19, 2025
picnixz pushed a commit that referenced this pull request Aug 19, 2025
…137935) (#137951)

[docs] fix grammar in ssl.SSLContect.sslsocket_class docs (GH-137935)

---------
(cherry picked from commit 379161d)

Co-authored-by: PrinceNaroliya <[email protected]>
Co-authored-by: Gregory P. Smith <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants