Report when section layout is invalid
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reproducing the failure with the docstring shown in the issue and inspect how section layouts are parsed. Determine how an invalid Returns section should be reported; done means this malformed layout produces a clear report instead of an unhandled failure.
Written by the indexing model from the issue text.
Description
The following docstring will currently fail.
""" This is a summary.
Returns
-----------
something that is returned
"""
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from enthought/sectiondoc
-
Difficulty 2/5 1-3 hours Newbie friendliness 38/100
enthought/sectiondoc#37 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
enthought/sectiondoc#32 ·
-
feature
Difficulty 5/5 Over a week Newbie friendliness 25/100
enthought/sectiondoc#30 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
enthought/sectiondoc#29 ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
enthought/sectiondoc#27 ·
All issues in enthought/sectiondoc
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100