Skip to content

Commit

Permalink
[docs] Update the guideline about splitting phrases (expo#22476)
Browse files Browse the repository at this point in the history
  • Loading branch information
amandeepmittal authored May 15, 2023
1 parent 3b52bbc commit 61d8d1e
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions guides/Expo Documentation Writing Style Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,11 @@ Do not add extra space between preceding and succeeding words and "/" just to em

### Splitting phrases

When it is necessary to split phrases, use em dashes (—), semicolons, or colons rather than commas to split phrases that read as separate sentences.
Try splitting phrases into separate sentences. Our goal is to make documentation easier to read and understand.

- Correct: JavaScript has come a long way; it was originally written in 10 days.
In rare cases when it is necessary to split phrases, use em dashes (—) or use connections (such as then, however, and so on) rather than commas to split phrases that read as separate sentences.

- Correct: JavaScript has come a long way since it was originally written in 10 days.
- Incorrect: JavaScript has come a long way, it was originally written in 10 days.

## Formatting
Expand Down Expand Up @@ -329,7 +331,7 @@ Writing API documentation accurately and precisely helps developers use our APIs
- Any of those annotations will hide the code and comments from the autogenerated API docs output.
- `@header`
- Allows to group methods by the custom headers, should be used with `headersMapping` prop for `APISection` component to control the actual header titles
and their order (see `expo-notifications` source and doc page for an example usage).
and their order (see `expo-notifications` source and doc page for an example usage).
- When linking other SDK packages in a comment, use `./` instead of `../` at the beginning of the URL
- For more information, check out [detect broken internal links in generated doc comments](https://github.com/expo/expo/pull/16771) PR on GitHub.

Expand Down

0 comments on commit 61d8d1e

Please sign in to comment.