Disable GL01 check in numpydoc by default.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
Could the GL01 check in numpydoc be dsiabled by default, please?
It contradicts the examples at the numpydoc docstring guide, and also PEP-257
where it says "The summary line may be on the same line as the opening quotes or on the next line.".
The code seems to be in numpydoc/validate.py :
"GL01": "Docstring text (summary) should start in the line immediately "
"after the opening quotes (not in the same line, or leaving a "
"blank line in between)",
and
if doc.start_blank_lines != 1 and "\n" in doc.raw_doc:
errs.append(error("GL01"))
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 in numpydoc/validate.py, at the GL01 message and the check using doc.start_blank_lines. Compare the intended default behavior with the numpydoc docstring guide and PEP-257, then verify that GL01 is disabled by default without changing other validation checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100