Markdown lists.
Open
Nobody has claimed this yet.
octogonz-parser-backlog
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
It would be useful to be able to include lists in doc comments:
/**
* This module does:
*
* - A thing.
* - Another thing.
* - One more thing.
*/
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.
Research direction
No files or tests are named. Start by locating the doc-comment parser and specification areas that handle block content, then trace how existing Markdown-like constructs are represented. Done means the example list is accepted and its intended structure is covered by tests and documented behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100