Support (detect?) missing blank line before Returns sections.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
It's not the fist time I come across this, but it looks like project regularly forget the blank line between Parameters and Return, leading to the Returns section being merged into Parameters.
That would likely need to update _read_to_next_section to use extra heuristics than read_to_next_empty_line,
Only checking for lines with ------, or ====== might not be sufficient as this also would match tracebacks.
https://github.com/Carreau/velin/issues/14 for reference.
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 tracing the section parsing around _read_to_next_section and its use of read_to_next_empty_line. Use the linked Velin issue for context on missing blank lines, then define detection behavior that separates Returns sections from traceback-like lines. Done means Parameters and Returns are parsed separately without introducing false section boundaries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100