urllib.parse - quote/unquote documentation issues
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
https://docs.python.org/3/library/urllib.parse.html
- It's my understanding that the arguement in the displayed usage shows the default. So:
urllib.parse.quote(string, safe='/', encoding=None, errors=None)
means thaterrorsdefaults toNoneType, however, the documentation just below that says:
"errors defaults to 'strict'
-
quote: There isn't a list of possible values for the "errors" argument -
unquote- There isn't a list of possible values for the "errors" argument -
unquote-
errors defaults to 'replace', meaning invalid sequences are replaced by a placeholder character.
What "placeholder character" is it that's used?
unquote
encoding defaults to 'utf-8'. errors defaults to 'replace', meaning invalid sequences are replaced by a placeholder character.
Is a single line. errors should be on a new line (all arguements for all functions really should always be on a new line unless there's a compelling reason not to. To do otherwise significantly impedes readability, while increasing the chances of misunderstanding).
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 linked urllib.parse documentation page and review the quote and unquote signatures and surrounding parameter descriptions. Resolve the reported defaults, errors value lists, placeholder-character explanation, and formatting concerns, with the page clearly documenting each function's arguments and behavior.
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
- Mostly clear
- Newbie friendliness
- 52/100