Document that sparse identifiers with whitespace are valid if quoted
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reviewing the existing sparse-identifier documentation and the related discussion in issue #1225. Add documentation showing that identifiers containing whitespace are valid when quoted, using the examples from this issue, and verify that the documentation build passes.
Written by the indexing model from the issue text.
Description
As a related improvement, we could also show that it's possible to use sparse identifiers with actual whitespaces when quoted. Like
pip ~= 23.1, orresolvelib > 0.5, != 0.6.0. I think, this makes them more readable and this style should be used in human-maintained files (as opposed to the tool-generated ones, like constraint pins made withpip-tools).
Originally posted by @webknjaz in https://github.com/pypa/packaging.python.org/issues/1225#issuecomment-1471867938
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Contributor guide
No contributing guide indexed for this repository
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.
More from pypa/packaging.python.org
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
pypa/packaging.python.org#1960 · 4 comments ·
-
`test` vs. `tests` Opencomponent: guides component: tutorials type: enhancement type: task
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
pypa/packaging.python.org#1165 · 5 comments ·
-
type: task
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
pypa/packaging.python.org#792 · 2 comments · 1 reaction ·
-
good first issue help wanted type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pypa/packaging.python.org#463 · 5 comments ·
-
good first issue type: task
Difficulty 3/5 1-2 days Newbie friendliness 68/100
pypa/packaging.python.org#2037 · 2 comments ·
All issues in pypa/packaging.python.org
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100