Skip to content

Improve documentation of SSL module #138633

Description

@picnixz

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

Activity

  1. self-assigned this
    on Sep 8, 2025
  2. added 10 commits that reference this issue on Sep 8, 2025
  3. picnixz commented on Sep 8, 2025

    @picnixz
    MemberAuthor

    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.

  4. removed their assignment
    on Sep 8, 2025
  5. added 2 commits that reference this issue on Sep 9, 2025
  6. added a commit that references this issue on Sep 18, 2025
  7. added a commit that references this issue on Sep 27, 2025
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 dirtopic-SSL

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions