docs: improve explanation of the `errors` argument of `urllib.parse` functions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
The URL quoting/unquoting functions in urllib.parse all have an errors argument, which is passed on to internal encode and decode functions.
The full explanation of what errors means is only explained in urllib.parse.quote.
The documentation for the other functions explains the the default behavior, but not any alternatives.
Each other function's documentation should should point to urllib.parse.quote for an explanation of errors.
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
Read the urllib.parse documentation for quote and the other URL quoting and unquoting functions. Use quote's existing explanation of the errors argument as the reference, then ensure each other function points to it and run the relevant documentation build to check the links and wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100