Skip to content

Commit 39833f8

Browse files
Apply suggestions from code review
Co-authored-by: Karuna-Mendix <144878669+Karuna-Mendix@users.noreply.github.com>
1 parent 136372c commit 39833f8

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/grammar-formatting.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For more information, see [ampersand (&)](https://docs.microsoft.com/en-us/style
4545

4646
Use bold for UI text (for example, button names and column names). Do not put UI text in quotation marks.
4747

48-
> If you can't find the toolbox, you can reopen it from the **View** menu.
48+
> If you cannot find the toolbox, you can reopen it from the **View** menu.
4949
>
5050
> Select **From database** as the **Source**.
5151
>
@@ -126,7 +126,7 @@ Use these phrases consistently when cross-referencing:
126126
127127
Do not bold or italicize text in cross-reference hyperlinks. Hyperlink formatting eliminates the need for additional emphasis.
128128

129-
Only link to URLs that use HTTPS. If you're working with a URL that uses HTTP, check if there's an HTTPS version available instead. If not, consider linking to a different site.
129+
Only link to URLs that use HTTPS. If you are working with a URL that uses HTTP, check if there is an HTTPS version available instead. If not, consider linking to a different site.
130130

131131
### Cross-Referencing Examples
132132

@@ -181,7 +181,7 @@ Use an en dash with spaces around it to set off introductory text in list items.
181181
182182
### Em Dash
183183

184-
Use an em dash (``) to set off a parenthetical phrase with more emphasis than parentheses provide. Don't add spaces around an em dash.
184+
Use an em dash (``) to set off a parenthetical phrase with more emphasis than parentheses provide. Do not add spaces around an em dash.
185185

186186
To insert an em dash, use the keyboard shortcut <kbd>Alt</kbd> + <kbd>0151</kbd> (or <kbd>Option</kbd> + <kbd>Shift</kbd> + <kbd>Minus sign</kbd> on a Mac).
187187

@@ -191,7 +191,7 @@ To insert an em dash, use the keyboard shortcut <kbd>Alt</kbd> + <kbd>0151</kbd>
191191
192192
## Dates {#dates}
193193

194-
Write dates in the format **month day, year** where:
194+
Write dates in the format **month day, year**, where:
195195

196196
* Month is the full month or a three-letter abbreviation
197197
* [Day is the cardinal number](#numbers) (16), not the ordinal number (16th)
@@ -253,7 +253,7 @@ Refer to the various parts of the reference guide as "topics."
253253

254254
Do not use bold for emphasis in regular documentation. An exception is that bold can be used to emphasize product names and technical terms in release notes.
255255

256-
Italics is reserved for user input and strings (which should always be in English). Do not use italics in other contexts, such as emphasis; because machine translation tools may not translate italicized words.
256+
Italics are reserved for user input and strings (which should always be in English). Do not use italics in other contexts, such as emphasis, because machine translation tools may not translate italicized words.
257257

258258
## Entity Names
259259

@@ -463,7 +463,7 @@ Do not use ordinal numbers for dates (see [Dates](#dates)).
463463

464464
Address the reader of your documents using the second person instead of the first person: use "you" or "your" instead of "we", "our", or "us".
465465

466-
Assume your reader is the person doing the tasks that you're documenting. Use "you" instead of "user", or use "end-user" when referring to the user of a Mendix app built on the Mendix Platform.
466+
Assume your reader is the person doing the tasks that you are documenting. Use "you" instead of "user", or use "end-user" when referring to the user of a Mendix app built on the Mendix Platform.
467467

468468
Always use "Mendix" instead of "we" in the regular documentation. Use "we" only in the Studio Pro release notes, which are written from the perspective of PMs or developers.
469469

@@ -493,13 +493,13 @@ You can replace an OpenID with a random UUID that you generate using a [UUID gen
493493

494494
Placeholders in sample code represent values that the user must replace when they use the sample code. For inline code placeholders, use code formatting, italics, and all caps. For code blocks, use all caps and add text instructions explaining what to replace.
495495

496-
Follow [Google's placeholder guidance](https://developers.google.com/style/placeholders): Use a short but descriptive name for the placeholder. Don't use generic text such as "input" or "placeholder". Use uppercase characters with underscore delimiters, unless that doesn't make sense in context.
496+
Follow [Google's placeholder guidance](https://developers.google.com/style/placeholders): Use a short but descriptive name for the placeholder. Do not use generic text such as "input" or "placeholder". Use uppercase characters with underscore delimiters, unless that does not make sense in context.
497497

498498
> When using the following command, replace `*NAMESPACE\_NAME`* with the name of your namespace.
499499
>
500500
> kubectl create namespace NAMESPACE\_NAME
501501
502-
Don't add ornaments around sample code placeholders unless the ornaments appear in the code.
502+
Do not add ornaments around sample code placeholders unless the ornaments appear in the code.
503503

504504
### Placeholders in Non-Code Elements
505505

@@ -511,7 +511,7 @@ For non-code placeholders (such as in the Studio Pro UI), add ornaments like quo
511511
512512
## Plurals in Parentheses
513513

514-
Do not put optional plurals in parentheses, for example "app(s)". Instead, use either the singular form or the plural form. If you must show both forms, write the singular form, then "or" and the plural form in parentheses.
514+
Do not put optional plurals in parentheses, for example, "app(s)". Instead, use either the singular form or the plural form. If you must show both forms, write the singular form, then "or" and the plural form in parentheses.
515515

516516
> Register the app environment (or environments).
517517

0 commit comments

Comments
 (0)