Improve Clarity and Consistency in Style Guide
- Dominant language
- No language data
- Stars
- 1.5k
- Forks
- 534
- PR merge metrics
- No merged PRs in 30d
Description
**Description**:
There are a few areas in the style guide that could be improved for clarity and consistency. Below are the suggested changes:
#### 1. Spacing Around Em Dashes
- The guide uses em dashes without consistent spacing around them. For example, in the sentence:
- "The length of the text on the first line before the em dash will break to the second line of text."
- **Suggestion**: Add space around em dashes for improved readability:
- "…will break to the second line — of text."
#### 2. Comma Usage in Lists
- The guide states: "Don’t use the Oxford comma," but also provides an example where it is used.
- **Suggestion**: Ensure consistency in the use of the Oxford comma throughout the document. Either avoid it entirely, or use it consistently.
#### 3. Clarify Numerals Section
- The section about abbreviating large numbers could benefit from more explicit clarification. For example:
- "Use 'K' for thousands (e.g., 10K for 10,000), 'M' for millions, and 'B' for billions."
- **Suggestion**: Rewrite to make the usage of these abbreviations more clear.
#### 4. General Formatting Consistency
- Ensure that all formatting (such as headings, subheadings, and bullet points) is consistent across the document for better readability.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.