Exception/crash when validating doc-string with `\`-line-break in summary
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
def foo():
"""
Quite long line, e.g., because I link to\
something and do not want to upset\
line length rules and keep this\
a single sentence.
"""
(Enough to have a single \, but for motivation.)
Leads to, when checking:
Handler <function mangle_docstrings at 0x000002E31CBBC550> for event 'autodoc-process-docstring' threw an exception (exception: unexpected indent (<unknown>, line 1))
Version: 1.5.0
(I guess the reason I started using \ is that some other checker, (velin?), allows this.)
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
Reproduce the reported exception with the Python docstring example containing backslash line breaks, then inspect the mangle_docstrings handler for the autodoc-process-docstring event. Done means validation no longer raises the unexpected-indent exception for this input while processing the summary as intended.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 43/100