Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Clarity and Consistency in Style Guide #40

Open
Durgesh4993 opened this issue Jan 15, 2025 · 0 comments
Open

Improve Clarity and Consistency in Style Guide #40

Durgesh4993 opened this issue Jan 15, 2025 · 0 comments

Comments

@Durgesh4993
Copy link

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant