Improve documentation of SSL module
Open
Nobody has claimed this yet.
docs
topic-SSL
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the SSL documentation points and the discussion in PR 138269, then review linked PRs 138639, 138646, 138647, 138648, and 138656. Done means resolving the remaining English wording question and completing the documentation checklist without leaving Sphinx reference warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100