Improve documentation of SSL module
Aperta
Nessuno ha ancora preso questa issue.
docs
topic-SSL
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dai punti della documentazione SSL e dalla discussione in PR 138269, quindi esamina i PR collegati 138639, 138646, 138647, 138648 e 138656. Il lavoro è completato quando viene risolta la questione ancora aperta sulla formulazione in inglese e viene completata la checklist della documentazione senza lasciare avvisi di riferimento Sphinx.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100