posit-dev / posit-dev/positron
Python: parse documentation for Python keywords
Open
Nobody has claimed this yet.
lang: python
- Dominant language
- TypeScript
- Stars
- 4.3k
- Forks
- 184
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 195
Description
When looking up keywords such as def or class, the restructured text is not parsed.
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 reproducing the lookup for the Python keywords def and class, then trace the documentation-rendering path that handles their reStructuredText. The issue names no files or tests, so identify where this lookup and parsing are implemented. Done means the reStructuredText documentation is parsed and displayed correctly for those keywords.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- developer-experience, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100