Skip to content

Commit 5875700

Browse files
(DOCSP-11394): Update Punctuation page (#44)
* (DOCSP-11394): Update Punctuation page * Apply suggestions from code review Co-authored-by: Anthony Sansone <[email protected]> * copy review Co-authored-by: Anthony Sansone <[email protected]>
1 parent fe3485e commit 5875700

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

source/style-guide/style/punctuation.txt

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44
Punctuation
55
===========
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/style/corrections.rst
810

911
Use punctuation correctly and consistently. This section provides
1012
guidelines for using punctuation in MongoDB documentation. For basic
11-
rules about punctuation, see a grammar reference, such as the
12-
*Harbrace College Handbook*.
13+
rules about punctuation, see :cmos17:`section 5, Grammar and Usage
14+
</part2/ch05/toc.html>` in the *Chicago Manual of Style*.
1315

1416
.. contents:: On this page
1517
:local:
@@ -62,8 +64,9 @@ Use the following guidelines for colons:
6264
Commas
6365
~~~~~~
6466

65-
Use the following guidelines for commas. For basic comma usage, see a
66-
grammar reference, such as the *Harbrace College Handbook*.
67+
Use the following guidelines for commas. For basic comma usage,
68+
:cmos17:`section 6.16, Commas </part2/ch06/psec016.html>` in the Chicago
69+
Manual of Style.
6770

6871
.. list-table::
6972
:widths: 40 30 30
@@ -116,10 +119,10 @@ grammar reference, such as the *Harbrace College Handbook*.
116119
However, you can easily update the version by using the
117120
WordPress management dashboard.
118121

119-
Unlike the other alarms in this list, you set the network check alarm
120-
variable upon network check creation.
122+
Unlike the other alarms in this list, you set the network check
123+
alarm variable upon network check creation.
121124

122-
For more information, see Upgrading your Private Cloud.
125+
To learn more, see Upgrading Ops Manager.
123126
- When you check your email with an IMAP connection you're
124127
accessing and managing your email directly from the email
125128
server.
@@ -130,7 +133,7 @@ grammar reference, such as the *Harbrace College Handbook*.
130133
Unlike the other alarms in this list you set the network check
131134
alarm variable upon network check creation.
132135

133-
For more information see Upgrading your Private Cloud.
136+
To learn more, see Upgrading Ops Manager.
134137

135138
* - Don't use a comma between the verbs in a compound predicate.
136139
- These open-source Python clients run on Linux or Mac OS X
@@ -293,8 +296,7 @@ be necessary in the following cases:
293296
*preemptive*, which aren't likely to be misread.
294297

295298
- The product team has hyphenated a term with a prefix, and you need
296-
to follow suit in the docs for consistency with the interface—for
297-
example, *multi-factor authentication* in the Identity product.
299+
to follow suit in the docs for consistency with the interface.
298300
Whenever possible, work with the teams to use preferred spelling.
299301

300302
For the correct formatting of a specific word, see a dictionary or
@@ -347,7 +349,7 @@ Periods
347349
~~~~~~~
348350

349351
Use the following guidelines for periods. For basic period usage, see a
350-
grammar reference, such as the *Harbrace College Handbook*.
352+
grammar reference, :cmos17:`section 6.12, Periods </part2/ch06/psec012.html>` in the *Chicago Manual of Style*.
351353

352354
- Use a period at the end of a declarative or imperative sentence, and
353355
insert only one space after the period.

0 commit comments

Comments
 (0)