Skip to content

Commit a22db01

Browse files
author
Chris Cho
authored
Merge pull request #154 from norareidy/fix-inconsistencies
Inconsistent capitalization info and typos
2 parents b228352 + c0aae24 commit a22db01

File tree

8 files changed

+14
-16
lines changed

8 files changed

+14
-16
lines changed

source/style-guide/error-message-guidelines.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Error Message Guidelines
66

77
.. default-domain:: mongodb
88

9-
Developers often ask an Technical Writer to edit error messages
9+
Developers often ask a technical writer to edit error messages
1010
that they have written.
1111

1212
When you edit error messages, use the writing guidelines in this Style

source/style-guide/markup/inline.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To learn more about when to use these roles, see the style guide section on
3131

3232
**bold**
3333

34-
- To *emphasize* or *italicize* text, use two asterisks on both sides
34+
- To *emphasize* or *italicize* text, use one asterisk on both sides
3535
of the text.
3636

3737
.. code-block:: rst

source/style-guide/quickstart.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,11 @@ the following ones to help you boost the effectiveness of your writing.
8686
- :ref:`use-correct-punctuation`
8787

8888
:ref:`punctuation`
89-
* - **Use sentence-style capitalization for all titles and
89+
* - **Use AP headline-style capitalization for all titles and
9090
headings**.
9191

92-
In sentence-style capitalization, you capitalize only the first
93-
word of the title or heading, plus any proper terms and terms
94-
that are always capitalized, such as some abbreviations.
92+
To meet AP headline-style (or AP title case) capitalization requirements,
93+
refer to the guidelines in the :ref:`titles-and-headings` guide.
9594
- :ref:`titles-and-headings`
9695
* - **Write clear and consistent code examples**.
9796

source/style-guide/screenshots/diagram-guidelines.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Text Formatting
101101
- **Font**: Set the font to **Helvetica**.
102102

103103
- **Titles:** Title must be **bolded**, aligned **left**, and be at
104-
least **24px** in size. Use sentence-style capitalization.
104+
least **24px** in size. Use headline-style capitalization.
105105

106106
Objects
107107
~~~~~~~

source/style-guide/style/punctuation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ in the *Chicago Manual of Style*.
138138
Unlike the other alarms in this list you set the network check
139139
alarm variable upon network check creation.
140140

141-
To learn more, see Upgrading Ops Manager.
141+
To learn more see Upgrading Ops Manager.
142142

143143
* - Don't use a comma between the verbs in a compound predicate.
144144
- These open-source Python clients run on Linux or Mac OS X

source/style-guide/style/tables.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ within tasks, procedures, and tutorials don't require titles.
4949

5050
When creating table titles, use the following guidelines:
5151

52-
- Use sentence-style capitalization for table titles. However, for
53-
words that are always uppercase or always lowercase, match that case.
52+
- Use headline-style capitalization for table titles. To learn more, see
53+
:ref:`titles-and-headings`.
5454
- Don't start a table title with an article (*a*, *an*, *the*).
5555
- Don't end a table title with a period or colon.
5656
- Place the title above the table, not below it, and format it in

source/style-guide/style/titles-and-headings.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ documentation.
1616
Capitalization
1717
--------------
1818

19-
- Use *headline-style* capitalization for most titles and headings,
19+
- Use *AP headline-style* capitalization for most titles and headings,
2020
including article, chapter, table, figure, and example titles, as
2121
well as section and procedure headings.
2222

@@ -28,7 +28,7 @@ Capitalization
2828
Guidelines for Headline-Style Capitalization
2929
--------------------------------------------
3030

31-
Title-style capitalization uses initial uppercase letters for the
31+
AP headline-style capitalization uses initial uppercase letters for the
3232
first, last, and all the significant words in the title.
3333

3434
Capitalize all words in the title except for the following types of

source/style-guide/terminology/general-term-guidelines/use-consistent-terms.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,9 @@ consistently throughout the documentation.
4545
same document can be confusing to users and translators, so avoid
4646
it when possible.
4747

48-
- Avoid neologisms. Examples of neologisms -- or
49-
newly invented words -- are *marketecture* or *edutainment*. Most
50-
such words are specific to a single business culture and aren't
51-
understood in other cultures.
48+
- Avoid neologisms. Examples of neologisms (newly invented words)
49+
include *marketecture* or *edutainment*. Most of these words are specific
50+
to a single business culture and aren't understood in other cultures.
5251

5352
- Standardize words and spelling across a documentation set.
5453

0 commit comments

Comments
 (0)