Repository navigation
Improve documentation of SSL module #138633
Description
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
ssldocumentation #138648 - gh-138633: indicate SSL backend requirements for SSL functions #138656
Activity
gh-138633: synchronize documented signatures of SSL objects with runt…
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
[3.13] pythongh-138633: synchronize documented signatures of SSL obje…
[3.13] pythongh-138633: synchronize documented signatures of SSL obje…
[3.13] pythongh-138633: synchronize documented signatures of SSL obje…
gh-138633: fix Sphinx references in `ssl` documentation (#138648)
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
[3.14] pythongh-138633: synchronize documented signatures of SSL obje…
[3.13] pythongh-138633: synchronize documented signatures of SSL obje…
picnixz commentedon Sep 8, 2025
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.
pythongh-138633: synchronize documented signatures of SSL objects wit…
pythongh-138633: fix Sphinx references in `ssl` documentation (python…
[3.13] gh-138633: synchronize documented signatures of SSL objects wi…
[3.14] gh-138633: synchronize documented signatures of SSL objects wi…