Improve documentation of SSL module
Offen
Dieses Issue hat noch niemand übernommen.
docs
topic-SSL
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
This is an umbrella issue for the points raised in https://github.com/python/cpython/pull/138269#discussion_r2328597995 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-138639
- gh-138646 (held for now, can wait)
- gh-138647 (held for now, can wait)
- gh-138648
- gh-138656
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den Punkten der SSL-Dokumentation und der Diskussion in PR 138269 und prüfe anschließend die verknüpften PRs 138639, 138646, 138647, 138648 und 138656. Erledigt ist die Aufgabe, wenn die noch offene Frage zur englischen Formulierung geklärt und die Dokumentations-Checkliste abgeschlossen ist, ohne Sphinx-Referenzwarnungen zu hinterlassen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100