Skip to content

Commit

Permalink
XS✔ ◾ Improving readability "/avoid-repetition/#emojis" (#8428)
Browse files Browse the repository at this point in the history
* Improving readability

* Auto-fix Markdown files

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
tiagov8 and github-actions[bot] authored Apr 24, 2024
1 parent 9c863a5 commit 0167a34
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions rules/avoid-repetition/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Good example – No repeated words... using the DRY principle

When there are multiple items listed, it can be challenging to distinguish between them quickly, leading to confusion and miscommunication. If the same emoji is repeated multiple times within a list, it can create visual clutter and make the list more difficult to read.

When creating a list that includes emojis, avoid repeating the same emoji 3 or more times within a list. Instead, add the emoji to a "introductory sentence" or "lead-in sentence". This helps to keep the content concise, readable, and consistent. Thus making it easy to scan the list and understand the benefits and drawbacks of a particular situation.

::: greybox

### ✅ Pros
Expand Down Expand Up @@ -88,8 +90,4 @@ Bad example – Using an excessive amount of emojis. Not following DRY :(
Good example – Using the DRY principle
:::

By avoiding repeated emojis within each category, the list remains clear and concise, which can improve communication and understanding. Thus making it easy to scan the list and understand the benefits and drawbacks of a particular situation.

**Tip:** When creating a list that includes emojis, avoid repeating the same emoji more than 3 times within the list. This helps to keep the list concise, readable, and consistent while still allowing for some repetition for emphasis or clarity.

Following the DRY principle by avoiding excessive repetition of words/emojis helps to create content that are visually interesting and easy to read, while also promoting efficient and maintainable content creation.

0 comments on commit 0167a34

Please sign in to comment.