ENH: Allow an empty string after the colon in variable descriptions in docstrings
Open
Nobody has claimed this yet.
docstring integrity
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
See https://github.com/numpy/numpy/pull/7626 for examples
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 examples in the linked NumPy pull request and trace the docstring variable-description parser that handles text after a colon. Confirm how empty descriptions are currently treated, then add coverage showing that an empty string is accepted and run the relevant test suite.
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
- Needs clarification
- Newbie friendliness
- 35/100