Skip to content

Commit 0036e47

Browse files
committed
Addressed review comments
1 parent 1f9db71 commit 0036e47

File tree

4 files changed

+49
-12
lines changed

4 files changed

+49
-12
lines changed

source/style-guide/style/callouts.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ When creating callouts, use the following guidelines:
8282
distract users. To avoid stacking callouts, group supplemental information
8383
from callouts into a dedicated section.
8484

85-
- Don't use callouts in tables and option lists, if possible, because
86-
callouts reduce the scannability of tables and options lists.
85+
- If possible, don't use callouts in tables and option lists
86+
Callouts reduce the scannability of tables and options lists.
8787

8888
- Avoid nesting callouts inside tables and other elements.
8989

@@ -94,7 +94,7 @@ When creating callouts, use the following guidelines:
9494

9595
- Avoid stacking callouts of the same type. For example, avoid adding
9696
one labeled note directly after another labeled note. Instead, use
97-
separate paragraphs or an unordered list within a single callout.
97+
a single callout that contains separate paragraphs or an unordered list.
9898

9999
The following callouts might appear in existing documentation but are
100100
deprecated. Don't use these callouts in new content:

source/style-guide/style/glossaries.txt

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,16 @@ Create a glossary to document the following items:
2020

2121
This section provides guidelines for the following items:
2222

23+
- :ref:`glossary-terms`
24+
- :ref:`glossary-definitions`
25+
- :ref:`glossary-xrefs`
26+
- :ref:`glossary-guidelines`
27+
2328
For guidelines about formatting glossary terms that are used in regular
2429
text, see :ref:`text-formatting`.
2530

31+
.. _glossary-terms:
32+
2633
Glossary Terms
2734
--------------
2835

@@ -58,6 +65,8 @@ slashes, and apostrophes continue a single word.
5865

5966
newspaper
6067

68+
.. _glossary-definitions:
69+
6170
Glossary Definitions
6271
--------------------
6372

@@ -119,6 +128,8 @@ The following table shows examples.
119128
and protocols that programmers can use to create application
120129
services by using an open application.
121130

131+
.. _glossary-xrefs:
132+
122133
Cross-References to Glossary Terms
123134
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124135

@@ -168,6 +179,8 @@ glossary:
168179
To recover by dropping the selected database and re-creating it.
169180
*Contrast with* copy over.
170181

182+
.. _glossary-guidelines:
183+
171184
Guidelines for a Comprehensive Glossary
172185
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173186

@@ -196,7 +209,7 @@ comprehensive glossary:
196209
information about third-party terms. A MongoDB glossary should
197210
contain mainly MongoDB terms. If the user could find the meaning
198211
outside of a MongoDB document by using a browser search, then we
199-
probably dont need to include it in the glossary. For example,
212+
probably don't need to include it in the glossary. For example,
200213
*Apache*.
201214

202215
- If a term is specific to one MongoDB service, start the definition

source/style-guide/style/links-and-cross-references.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Links and Cross-References
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
915
Documentation writers use links to direct users to related material
1016
outside of the current page or section. Links may be:
1117

@@ -79,7 +85,6 @@ Minimize Repeated Links
7985
~~~~~~~~~~~~~~~~~~~~~~~
8086

8187
- Don't link to the same target multiple times in the same section.
82-
8388
You may link to the same target multiple times on the same page, but
8489
think carefully about whether it's absolutely necessary. For example,
8590
if a page is particularly long and contains many sections, then it might

source/style-guide/style/tables.txt

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,27 @@ Tables
1212
:depth: 2
1313
:class: singlecol
1414

15-
Text that's difficult to read in paragraph form often becomes clear
16-
when put into a table. Tables clarify the relationships among
17-
information, and they're easy to scan. This topic provides the
18-
guidelines for the following aspects of tables:
19-
20-
Example tables that reflect the guidelines are presented in a separate
21-
section at the end of this topic.
15+
Text that's difficult to read in paragraph form often becomes clearer
16+
when put into a table. Tables are easy to scan. They clarify the
17+
relationships between portions of information on the page. This topic
18+
provides the guidelines for the following aspects of tables:
19+
20+
- :ref:`tables-intros`
21+
- :ref:`tables-titles`
22+
- :ref:`tables-column-headers`
23+
- :ref:`tables-text`
24+
- :ref:`tables-footnotes`
25+
- :ref:`tables-apis`
26+
- :ref:`tables-examples`
2227

2328
.. note::
2429

2530
Don't create tables that are overly complex or that scroll
2631
horizontally. If a table has too much information, try to break it
2732
up into smaller tables.
2833

34+
.. _tables-intros:
35+
2936
Introductory Text for Tables
3037
----------------------------
3138

@@ -39,6 +46,8 @@ the table is in a different article or section.
3946
To introduce a table, use a sentence (not a fragment), and end the
4047
sentence with a colon.
4148

49+
.. _tables-titles:
50+
4251
Table Titles
4352
------------
4453

@@ -66,6 +75,8 @@ When creating table titles, use the following guidelines:
6675

6776
- Don't include trademark symbols in table titles.
6877

78+
.. _tables-column-headers:
79+
6980
Column Headers
7081
--------------
7182

@@ -78,6 +89,8 @@ Use the following guidelines for text in column headers:
7889
otherwise.
7990
- Don't end column headers with ellipses or colons.
8091

92+
.. _tables-text:
93+
8194
Table Text
8295
----------
8396

@@ -101,6 +114,8 @@ Use the following guidelines for text in table cells:
101114
percent).
102115
- Don't use color to differentiate table text.
103116

117+
.. _tables-footnotes:
118+
104119
Table Footnotes
105120
---------------
106121

@@ -133,6 +148,8 @@ can use footnotes.
133148
cell. Use a cell-level footnote if the note applies to multiple
134149
cells in the table.
135150

151+
.. _tables-apis:
152+
136153
Attribute or Parameter Tables in API documents
137154
----------------------------------------------
138155

@@ -157,6 +174,8 @@ following additional guidelines:
157174
definition list or itemized list instead of a table.
158175
- Avoid putting definition lists in tables.
159176

177+
.. _tables-examples:
178+
160179
Examples
161180
--------
162181

0 commit comments

Comments
 (0)