Allow param lists to split on ': ' rather than ' : '
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
It is very easy to mistakenly separate parameter names from their type description by ': ' instead of the correct ' : '. There are at least 260 instances in Scikit-learn, for instance, and Joblib appears to use : without a preceding space as a standard. This variation is unsurprising when See Also, for instance, does not require a space before its colons.
Would we expect great ramifications were we to change it to allow a single colon followed by whitespace as delimiter?
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
The issue names no files or tests; start by locating the parameter-list parsing entry point and its existing delimiter tests. Check how ' : ' is currently recognized and whether ': ' can be accepted without changing other field syntax; done means the new delimiter works while existing parsing remains compatible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100