Documentation for new -W regex support fails to mention length requirement
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
-W will now support regex. The documentation says that “If it starts and ends with a forward slash (/)” the message field will be a regular expression. This is incorrect, there is an additional requirement that the field be at least two characters long. / is one character long and starts and ends with a forward slash, but it is not interpreted as a regex (it matches literal /).
Linked PRs
- gh-147969
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 by locating the CPython documentation for the new -W regex support and read the wording about fields that start and end with a slash. Compare it with the issue's length requirement; the work is done when the documentation accurately describes both conditions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100