Skip to content

Commit

Permalink
S ◾ removed greater sign on "x-to-y" + bad example + line break on No…
Browse files Browse the repository at this point in the history
…te for "indent" rule (#9926)

* Line break on Note for "indent" rule

* Update rule.md

* Update rule.md
  • Loading branch information
tiagov8 authored Feb 20, 2025
1 parent cb99b08 commit 0af4dd0
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
4 changes: 2 additions & 2 deletions rules/change-from-x-to-y/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,15 @@ On CodeAuditor web page ssw.com.au/ssw/codeauditor

From:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\> Scan all your projects for coding <span style="background-color:#ff0000;color:#fff;font-weight:bolder;">bugs and</span> errors:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Scan all your projects for coding <span style="background-color:#ff0000;color:#fff;font-weight:bolder;">bugs and</span> errors:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Enforce industry best practices.

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Friendly licensing model pay nothing for the full version!

To:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\> Scan all your projects for coding errors
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Scan all your projects for coding errors

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - <mark>Guarantee</mark> industry best practices

Expand Down
30 changes: 26 additions & 4 deletions rules/indent/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@ guid: 1899c3db-ac1b-468e-a8e7-f2cdc5e0748a

Written communication can easily cause misunderstandings. Help the reader understand your message better by:

* Using “&gt;” and indentation when quoting the text from others, like the original email you are replying to
* Using “&gt;” and indentation when quoting the text from others, like the original email you are replying to.\
**Note:**&gt;” is not needed when quoting from a web page
* Your text should be kept to the left
* Make the question/task followed by the respective answer in a logical order
* [Add numbers to tasks](/number-tasks-questions) if the sender forgot.\
Mention you changed the history. E.g. “(added numbers to tasks in the history, so we can clearly refer to them)”
* Your text should be always kept to the left

<!--endintro-->

Expand Down Expand Up @@ -67,15 +68,36 @@ Figure: Bad example - There's too much information with no reasonable order

### Hi Adam

"Please change from X to Y"\
Done - northwind365.com\
"The program flow logic worries me a bit"\
Sorry, this wasn't a final decision - I just put it there for testing purposes

:::
:::
::: bad
Figure: Bad example - Order is OK, but it's using quotes to reference others' text + no indentation + missing numbers on questions/tasks
:::

::: email-template

| | |
| -------- | --- |
| To: | Adam |
| Subject: | RE: Change on Northwind app |
::: email-content

### Hi Adam

&nbsp;&nbsp;&nbsp; > 1. Please change from X to Y\
Done - northwind365.com\
&nbsp;&nbsp;&nbsp; > 2. The program flow logic worries me a bit\
Sorry, this wasn't a final decision - I just put it there for testing purposes

:::
:::
::: bad
Figure: Bad example - Even with order, without spacing the text becomes cramped and hard to read
::: ok
Figure: OK example - Even with ">", indentation and numbers, without spacing the text becomes cramped and hard to read
:::

::: email-template
Expand Down

0 comments on commit 0af4dd0

Please sign in to comment.