You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/grammar-formatting.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ For more information, see [ampersand (&)](https://docs.microsoft.com/en-us/style
45
45
46
46
Use bold for UI text (for example, button names and column names). Do not put UI text in quotation marks.
47
47
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.
49
49
>
50
50
> Select **From database** as the **Source**.
51
51
>
@@ -126,7 +126,7 @@ Use these phrases consistently when cross-referencing:
126
126
127
127
Do not bold or italicize text in cross-reference hyperlinks. Hyperlink formatting eliminates the need for additional emphasis.
128
128
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.
130
130
131
131
### Cross-Referencing Examples
132
132
@@ -181,7 +181,7 @@ Use an en dash with spaces around it to set off introductory text in list items.
181
181
182
182
### Em Dash
183
183
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.
185
185
186
186
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).
187
187
@@ -191,7 +191,7 @@ To insert an em dash, use the keyboard shortcut <kbd>Alt</kbd> + <kbd>0151</kbd>
191
191
192
192
## Dates {#dates}
193
193
194
-
Write dates in the format **month day, year** where:
194
+
Write dates in the format **month day, year**, where:
195
195
196
196
* Month is the full month or a three-letter abbreviation
197
197
*[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."
253
253
254
254
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.
255
255
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.
257
257
258
258
## Entity Names
259
259
@@ -463,7 +463,7 @@ Do not use ordinal numbers for dates (see [Dates](#dates)).
463
463
464
464
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".
465
465
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.
467
467
468
468
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.
469
469
@@ -493,13 +493,13 @@ You can replace an OpenID with a random UUID that you generate using a [UUID gen
493
493
494
494
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.
495
495
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.
497
497
498
498
> When using the following command, replace `*NAMESPACE\_NAME`* with the name of your namespace.
499
499
>
500
500
> kubectl create namespace NAMESPACE\_NAME
501
501
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.
503
503
504
504
### Placeholders in Non-Code Elements
505
505
@@ -511,7 +511,7 @@ For non-code placeholders (such as in the Studio Pro UI), add ornaments like quo
511
511
512
512
## Plurals in Parentheses
513
513
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.
0 commit comments