GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-138633: synchronize documented signatures of SSL objects with runtime ones by picnixz · Pull Request #138639 · python/cpython

Conversation

@picnixz

@picnixz picnixz commented Sep 8, 2025 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Ideally I would like to make all "weird" parameters positional-only, but this would be a long deprecation period that we would need. So let's just document the exact names of the signatures. It won't cleanly backport because there are new functions but I will take care of this later.

  • Issue: Improve documentation of SSL module #138633

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@picnixz
synchronize documented signatures with runtime ones
286b051
@picnixz
picnixz requested a review from gpshead as a code owner September 8, 2025 09:20
@picnixz picnixz added the skip news label Sep 8, 2025
@bedevere-app bedevere-app Bot added awaiting core review docs Documentation in the Doc dir labels Sep 8, 2025
@github-project-automation github-project-automation Bot added this to Docs PRs Sep 8, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Sep 8, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Sep 8, 2025
Improve documentation of SSL module #138633
Open
3 of 4 tasks
@picnixz
picnixz enabled auto-merge (squash) September 8, 2025 09:24
@picnixz
picnixz merged commit 3255c0c into python:main Sep 8, 2025
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Sep 8, 2025
@bedevere-app bedevere-app Bot removed the awaiting core review label Sep 8, 2025
@picnixz
picnixz deleted the docs/ssl/func-signatures-138633 branch September 8, 2025 11:02
picnixz added a commit to picnixz/cpython that referenced this pull request Sep 8, 2025
@picnixz
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
2567fd4 
…cts with runtime ones (pythonGH-138639)

(cherry picked from commit 3255c0c)

Co-authored-by: Bénédikt Tran <[email protected]>
picnixz added a commit to picnixz/cpython that referenced this pull request Sep 8, 2025
@picnixz
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
4dd36f3 
…cts with runtime ones (pythonGH-138639)

(cherry picked from commit 3255c0c)
@bedevere-app

bedevere-app Bot commented Sep 8, 2025

Copy link
Copy Markdown

GH-138646 is a backport of this pull request to the 3.14 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
picnixz added a commit to picnixz/cpython that referenced this pull request Sep 8, 2025
@picnixz
[3.13] pythongh-138633: synchronize documented signatures of SSL obje…
bcc2739 
…cts with runtime ones (pythonGH-138639)

(cherry picked from commit 4dd36f3)

Co-authored-by: Bénédikt Tran <[email protected]>
(cherry picked from commit 3255c0c)
@bedevere-app

bedevere-app Bot commented Sep 8, 2025

Copy link
Copy Markdown

GH-138647 is a backport of this pull request to the 3.13 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
1 similar comment
@bedevere-app

bedevere-app Bot commented Sep 8, 2025

Copy link
Copy Markdown

GH-138647 is a backport of this pull request to the 3.13 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
picnixz added a commit to picnixz/cpython that referenced this pull request Sep 8, 2025
@picnixz
[3.13] pythongh-138633: synchronize documented signatures of SSL obje…
6978fb7 
…cts with runtime ones (pythonGH-138639)

(cherry picked from commit 4dd36f3)
picnixz added a commit to picnixz/cpython that referenced this pull request Sep 8, 2025
@picnixz
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
3d74019 
…cts with runtime ones (pythonGH-138639)

(cherry picked from commit 3255c0c and 4ef51fa)
picnixz added a commit to picnixz/cpython that referenced this pull request Sep 8, 2025
@picnixz
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
3846c06 
…cts with runtime ones (pythonGH-138639, pythonGH-138648)

(cherry picked from commit 3255c0c)
(cherry picked from commit 4ef51fa)
picnixz added a commit to picnixz/cpython that referenced this pull request Sep 8, 2025
@picnixz
[3.13] pythongh-138633: synchronize documented signatures of SSL obje…
ac5149f 
…cts with runtime ones (pythonGH-138639, pythonGH-138648)

(cherry picked from commit 4dd36f3)
(cherry picked from commit 4ef51fa)
lkollar pushed a commit to lkollar/cpython that referenced this pull request Sep 9, 2025
@picnixz @lkollar
pythongh-138633: synchronize documented signatures of SSL objects wit…
bd605bf 
…h runtime ones (python#138639)
Yhg1s pushed a commit that referenced this pull request Sep 18, 2025
@picnixz
[3.13] gh-138633: synchronize documented signatures of SSL objects wi…
3b24402 
…th runtime ones (GH-138639, GH-138648) (#138647)

(cherry picked from commit 4dd36f3)
(cherry picked from commit 4ef51fa)
hugovk pushed a commit that referenced this pull request Sep 27, 2025
@picnixz
[3.14] gh-138633: synchronize documented signatures of SSL objects wi…
4608a30 
…th runtime ones (GH-138639, GH-138648) (#138646)

(cherry picked from commit 3255c0c)
(cherry picked from commit 4ef51fa)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@picnixz
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.