Make placeholder names more explicit
Open
Nobody has claimed this yet.
Aspect: Documentation
Status: Adopted
Type: Docs Debt
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
People may get stuck putting in the literal text (or angle brackets) from placeholder values. Either a note or clarifying text should be added when using placeholders.
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
No file or test is named. Search the documentation for placeholder values and review how they are presented to readers. Done means placeholder text or notes clearly explain that the example value and angle brackets should not be copied literally.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100