Bullet's nested indentation for params
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
I assume this is where issues for vscode's tsdoc rendering should land? Or does that belong on a vscode repository?
Is there some reasoning for why bullet indentation doesn't work for function parameters?
I find myself trying to write bullet lists just to add a little structure for parameter descriptions, in cases where their purpose might need a bit more in-depth documentation. It never really works out very well 😆
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
Start by confirming whether nested parameter-list indentation belongs in TSDoc or in VS Code's renderer, then compare the two screenshots with the current rendering behavior. Trace the relevant parameter-description and bullet-list handling, and define the expected indentation before deciding whether a specification or implementation change is appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100