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 — Improve documentation of SSL module · Issue #138633 · python/cpython

Improve documentation of SSL module #138633

New issue
Copy link
New issue
Copy link
Open
Open
Improve documentation of SSL module#138633
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dirtopic-SSL

Description

@picnixz
picnixz
opened on Sep 8, 2025
Issue body actions

This is an umbrella issue for the points raised in #138269 (comment) that I will restate below:

  • Indicate positional-only parameters in SSL docs.
  • Indicate which OpenSSL version is required for a given functionality.
  • Reword some English if needed (I don't know if it's needed but maybe).
  • Fix Sphinx references warnings.

cc @ronf

Linked PRs

  • gh-138633: synchronize documented signatures of SSL objects with runtime ones #138639
  • [3.14] gh-138633: synchronize documented signatures of SSL objects with runtime ones (GH-138639, GH-138648) #138646 (held for now, can wait)
  • [3.13] gh-138633: synchronize documented signatures of SSL objects with runtime ones (GH-138639, GH-138648) #138647 (held for now, can wait)
  • gh-138633: fix Sphinx references in ssl documentation #138648
  • gh-138633: indicate SSL backend requirements for SSL functions #138656

Activity

  1. picnixz
    self-assigned this
    on Sep 8, 2025
  2. picnixz
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Sep 8, 2025
  3. github-project-automation
    added this to docs issueson Sep 8, 2025
  4. github-project-automation
    moved this to Todo in docs issueson Sep 8, 2025
  5. picnixz
    added
    topic-SSL
    on Sep 8, 2025
  6. picnixz
    added 10 commits that reference this issue on Sep 8, 2025

    gh-138633: synchronize documented signatures of SSL objects with runt…

    3255c0c

    [3.14] pythongh-138633: synchronize documented signatures of SSL obje…

    2567fd4

    [3.14] pythongh-138633: synchronize documented signatures of SSL obje…

    4dd36f3

    [3.13] pythongh-138633: synchronize documented signatures of SSL obje…

    bcc2739

    [3.13] pythongh-138633: synchronize documented signatures of SSL obje…

    e7e97fb

    [3.13] pythongh-138633: synchronize documented signatures of SSL obje…

    6978fb7

    gh-138633: fix Sphinx references in `ssl` documentation (#138648)

    4ef51fa

    [3.14] pythongh-138633: synchronize documented signatures of SSL obje…

    3d74019

    [3.14] pythongh-138633: synchronize documented signatures of SSL obje…

    3846c06

    [3.13] pythongh-138633: synchronize documented signatures of SSL obje…

    ac5149f

  7. picnixz commented on Sep 8, 2025

    @picnixz
    picnixz
    on Sep 8, 2025
    MemberAuthor
    More actions

    There is still the "rewording" task to do, but this is not pressing. I don't have the courage to do it now so I'll just consider this to be completed. If someone wants to fix typos in the docs they can.

  8. picnixz
    removed their assignment
    on Sep 8, 2025
  9. lkollar
    added 2 commits that reference this issue on Sep 9, 2025

    pythongh-138633: synchronize documented signatures of SSL objects wit…

    bd605bf

    pythongh-138633: fix Sphinx references in `ssl` documentation (python…

    3cf19f3
  10. Yhg1s
    added a commit that references this issue on Sep 18, 2025

    [3.13] gh-138633: synchronize documented signatures of SSL objects wi…

    3b24402
  11. hugovk
    added a commit that references this issue on Sep 27, 2025

    [3.14] gh-138633: synchronize documented signatures of SSL objects wi…

    4608a30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirDocumentation in the Doc dirtopic-SSL

    Projects

    • docs issues
      Status
      Todo
      Show more project fields

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions
    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.