[Typo]: em dash spacing
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Summary
Throughout the documentation, there's inconsistent use of the em dash (—, or —). Sometimes there's spaces surrounding them, and sometimes not.
Page
N/A
Details
Typically, em dashes are used without surrounding spaces. Personally, I prefer that style. However, I think whichever's fine as long as you follow a consistent style throughout.
I can open a PR making all these changes once I know which way we want to go: spaces or not.
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
The issue names no specific files, so first review the documentation for existing em-dash usage and read the linked punctuation guidance. Confirm whether the project wants spaces or no spaces, then update all documentation occurrences consistently and verify that mixed spacing is gone.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100