microsoft / microsoft/vscode-documentdb
Different text delimiters without clear purpose/distinction
Open
Nobody has claimed this yet.
bug-bash
- Dominant language
- TypeScript
- Stars
- 31
- Forks
- 22
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 21
Description
It's not clear why different delimiters are being used and what they mean, like an em-dash, a - (or is it a single bullet?) or the double-bullets ••.
In general the best practice is to use em-dashes in all these cases.
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 reviewing the text shown in the attached image and locate the places using em-dashes, hyphens or double bullets. Confirm the intended distinction, then standardize the affected text to em-dashes where appropriate. No file or test is named, so completion means all relevant delimiters are consistent and their purpose is clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- content
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100