-
Notifications
You must be signed in to change notification settings - Fork 379
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from lucacurranCB/patch-1
Update editorial-style-guide.md
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2c200ec
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling and Formatting
"on-chain" or "on chain"
While the text specifies that "onchain" should be spelled as one word, it redundantly lists alternate spellings. This can be consolidated for clarity.
Correction:
Remove "on-chain" or "on chain" or "On Chain" to avoid unnecessary repetition.
Redundancies
Repetition in "Use technical terms sparingly..."
The guideline emphasizes explaining technical terms fully. However, this is restated multiple times throughout the text.
Correction:
"Use technical terms sparingly, explaining them fully where necessary." simplifies the instruction.
Awkward Phrasing
"Have your brand supercede Base"
The correct spelling is "supersede," not "supercede."
Inconsistencies in Style
Inconsistent Capitalization
For example, "BRAND x Base" uses full capitalization for "BRAND," while "Base x BRAND" does not. Consider standardizing capitalization conventions for readability and professionalism.
Ambiguities
"ETH demonination, not USD..."
"ETH denomination" is misspelled as "demonination." Additionally, clarify whether this applies to all mentions of prices or only within specific contexts.
Structure and Flow
In "What to Avoid" Section
Some items are repetitive or redundant:
"Overly Aggressive Marketing" and "False or Misleading Information" could overlap if a clarification isn't provided.
"Non-Compliant Contests or DeFi Offers" might benefit from specifics or examples.
Correction:
Group related items or provide brief examples for clarity. E.g., "Avoid misleading promotions, including aggressive marketing, false claims, or non-compliant contests."
Technical Errors
"Disputable Superlative" vs. "Disputable Superlatives"
The phrase "Disputable Superlative" should be plural to match the context.
Readability
Long Sentence in Clarity Section
The sentence:
"This doesn’t mean that you should ignore subtle and sophisticated complexities in your theory – but the challenge is to state those complexities simply and clearly."
Can be split for better readability.
Correction:
"This doesn’t mean you should ignore subtle complexities. The challenge is to state them simply and clearly."
By implementing these corrections, the text will achieve improved clarity, precision, and professionalism.