Fix formatting of examples in the docstrings
Open
documentation
- Dominant language
- Python
- Stars
- 5
- Forks
- 1
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
Multiline blocks of code should start with `...`, otherwise they're rendered as output strings.
For instance
Contributor guide
Research direction
Search the Python source for multiline code examples in docstrings, using the issue screenshots to identify the formatting problem. Check how those examples are rendered, then update the affected docstrings so code blocks start with `...` and are no longer rendered as output strings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100