Skip to content

Commit

Permalink
Update writing.adoc
Browse files Browse the repository at this point in the history
spaces

Signed-off-by: Kersten Richter <[email protected]>
  • Loading branch information
kersten1 authored Aug 1, 2024
1 parent 17430b3 commit ef3f367
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions src/writing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ Use simple and direct language. Avoid using unnecessary phrases, such as saying
|Yes
|No

|To build a chip,
|To build a chip,
|In order to build a chip,

|See the Hypervisor extension.
|See the Hypervisor extension.
|Please see the Hypervisor extension.

|View the register.
|View the register.
|With this next command, we'll view the register.
|===

Expand Down Expand Up @@ -99,13 +99,12 @@ whether they're part of the "we" you're describing.
|RISC-V provides a new feature for
|We provide a new feature

|This page teaches you how to create CSRs.
|This page teaches you how to create CSRs.
|In this page, we are going to learn about CSRs.
|===

An exception for using "we" is the rationale sections.


=== Avoid jargon and idioms

Some readers speak English as a second language. Avoid jargon and idioms to help them understand better.
Expand Down Expand Up @@ -159,10 +158,10 @@ Avoid words such as "just", "simply", "easy", "easily", or "simple". These words
|Include one command in
|Include just one command in

|Run the command
|Run the command
|Simply run the command

|You can remove
|You can remove
|You can easily remove

|These steps
Expand Down

0 comments on commit ef3f367

Please sign in to comment.