Skip to content

Commit 9c389f9

Browse files
(DOCSP-11396): Update Tables page (#64)
* (DOCSP-11396): Update Tables page * Apply suggestions from code review Co-authored-by: Anthony Sansone <[email protected]> * copy review * Apply suggestions from code review Co-authored-by: Anthony Sansone <[email protected]> * copy review 2 * Fix build error from recent merge Co-authored-by: Anthony Sansone <[email protected]>
1 parent 86a2a97 commit 9c389f9

File tree

2 files changed

+39
-38
lines changed

2 files changed

+39
-38
lines changed

source/style-guide/style/punctuation.txt

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

77
.. default-domain:: mongodb
88

9-
.. include:: /includes/style/corrections.rst
9+
.. include:: /includes/styles/corrections.rst
1010

1111
Use punctuation correctly and consistently. This section provides
1212
guidelines for using punctuation in MongoDB documentation. For basic

source/style-guide/style/tables.txt

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Tables
55
======
66

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

911
Text that's difficult to read in paragraph form often becomes clear
1012
when put into a table. Tables clarify the relationships among
@@ -42,20 +44,20 @@ sentence with a colon.
4244
Table Titles
4345
------------
4446

45-
Tables should normally have titles (captions). However, some tables are
46-
closely associated with the surrounding text and don't require titles.
47-
For example, decision matrixes and tables within tasks, procedures, and
48-
tutorials don't require numbers or titles.
47+
Tables in conceptual topics should normally have titles (captions).
48+
However, some tables are closely associated with the surrounding text
49+
and don't require titles. For example, decision matrixes and tables
50+
within tasks, procedures, and tutorials don't require titles.
4951

5052
When creating table titles, use the following guidelines:
5153

5254
- Use sentence-style capitalization for table titles. However, for
5355
words that are always uppercase or always lowercase, match that case.
5456
- Don't start a table title with an article (*a*, *an*, *the*).
5557
- Don't end a table title with a period or colon.
56-
- Place the title above the table, not below it, and tag it as bold.
57-
- Don't manually number table titles. If titles should be numbered, the
58-
style sheet will number them.
58+
- Place the title above the table, not below it, and format it in
59+
**boldface**.
60+
- Don't number table titles.
5961
- Make table titles concise; limit them to one line if possible.
6062
- Make table titles descriptive:
6163

@@ -71,7 +73,7 @@ Column Headers
7173

7274
Use the following guidelines for text in column headers:
7375

74-
- Use sentence-style capitalization in column headers. However, for
76+
- Use headline-style capitalization in column headers. However, for
7577
words that are always uppercase or always lowercase, match that
7678
case.
7779
- Use singular nouns for column headers, unless the context requires
@@ -94,7 +96,7 @@ Use the following guidelines for text in table cells:
9496
for matrix-type tables that use an X or other marker to indicate
9597
support. In such cases, blank cells are acceptable (see the third
9698
example at the end of this topic).
97-
- When showing a call-out (for example, a note or warning) in a table,
99+
- When showing a callout (for example, a note or warning) in a table,
98100
use the guidelines in :ref:`callouts`.
99101
- If space in a table is constrained, you can use abbreviations and
100102
symbols that you wouldn't normally use in body text (such as % for
@@ -107,7 +109,7 @@ Table Footnotes
107109
If a callout (for example, a note or warning) applies to the entire
108110
table, place the content in a regular callout preceding the table. If
109111
a callout applies only to the content in a certain cell, place the
110-
callout in that cell. However, if a call-out applies to all of the
112+
callout in that cell. However, if a callout applies to all of the
111113
content in a row or column, or to the content in two or more cells, you
112114
can use footnotes.
113115

@@ -123,10 +125,10 @@ can use footnotes.
123125
- Place the footnote text at the end of the table, either in a final
124126
row that spans the entire table or under the last row in the table.
125127

126-
- Use superscript numbers to indicate the footnotes in the cells to
127-
which they apply. If numbers might be confusing (for example,
128-
because the text in the cells are numerical values), use lowercase
129-
letters instead.
128+
- Use :rst:`{+rst+} markup </restructuredtext.html#footnotes>`
129+
to set the footnotes in the cells to which they apply. If
130+
numbers might be confusing (because maybe the text in the
131+
cells are numerical values), use symbols instead.
130132

131133
- A footnote cited in a column header applies to the entire column.
132134
- A footnote cited in a table cell applies to the text in that
@@ -141,12 +143,18 @@ following additional guidelines:
141143

142144
- For tables that describes JSON or XML attributes, write the first
143145
sentence of a description with an implied subject. For example, if
144-
the attribute is name, the description might be as follows: "Server
145-
name, which becomes the initial host name of the server"
146-
- For attributes, include the valid values and default value at the
147-
end of the description. Use the formats "Valid values are *n* and
148-
*n*." and "The default is *n*." For example, "Valid values are
149-
``true`` and ``false``." and "The default is ``false``."
146+
the attribute is name, the description might be as follows:
147+
"Initial hostname of the server."
148+
- For attributes or parameters, include the valid values and default
149+
value at the end of the description.
150+
151+
- For request parameters, use the formats "Application accepts
152+
*n* or *n*." and "The default is *n*." For example, "Atlas accepts
153+
``true`` or ``false``." and "The default is ``false``."
154+
- For response parameters, use the formats "Application returns
155+
*n* or *n*." and "The default is *n*." For example, "Atlas returns
156+
``true`` or ``false``." and "The default is ``false``."
157+
150158
- If table descriptions or construction is complex, consider using a
151159
definition list or itemized list instead of a table.
152160
- Avoid putting definition lists in tables.
@@ -164,25 +172,25 @@ The following table explains the different parts of the preceding URL:
164172
- Explanation
165173

166174
* - ``swift://``
167-
- The prefix that passes file system requests to the Swift file
175+
- Prefix that passes file system requests to the Swift file
168176
system.
169177

170178
* - ``acontainer``
171-
- The name of the container in Swift that contains the objects to
179+
- Name of the container in Swift that contains the objects to
172180
be accessed. Container names must conform to RFC952 restrictions
173181
for host names—that is, the characters A-Z, numbers 0-9, and the
174182
hyphen (-).
175183

176184
Nonconforming container names are inaccessible by swiftfs.
177185

178186
* - ``aservice``
179-
- A user-friendly "service" name. A service name maps to a
187+
- User-friendly "service" name. A service name maps to a
180188
collection of configuration entries in the Hadoop core-site.xml
181189
file that specify where the container is located (for example,
182190
MongoDB-dfw).
183191

184192
* - ``/path/to/files``
185-
- The name of the object or objects in Swift to be referenced.
193+
- Name of the object or objects in Swift to be referenced.
186194
Although Swift doesn't support paths, swiftfs attempts to
187195
interpret names that look like paths and behave appropriately.
188196
For example, an input path named ``/path/to/*`` would qualify
@@ -254,37 +262,30 @@ The following matrix indicates which upgrade scenarios are supported:
254262
- X
255263
-
256264

257-
* - 3 (OpenCenter) to any version
258-
-
259-
- X
260-
261-
* - 2 (Alamo) to any version
262-
-
263-
- X
264-
265265
The following chart compares these top content management systems (CMSs):
266266

267267
.. list-table::
268268
:widths: 20 40 40
269269
:header-rows: 1
270+
:stub-columns: 1
270271

271272
* -
272273
- Drupal
273274
- WordPress
274275

275-
* - **Homepage**
276+
* - Homepage
276277
- www.drupal.org
277278
- www.wordpress.org
278279

279-
* - **About**
280+
* - About
280281
- Drupal is a powerful, developer-friendly tool for building
281282
complex sites. Like most powerful tools, it requires some
282283
expertise and experience to operate.
283284
- WordPress began as an innovative, easy-to-use blogging platform.
284285
With an ever-increasing repertoire of themes, plug-ins, and
285286
widgets, this CMS is also widely used for other website formats.
286287

287-
* - **Example sites**
288+
* - Example sites
288289
- Community Portal: Fast Company, Team Sugar
289290
- Social Networking: PlayStation Blog
290291

@@ -294,6 +295,6 @@ The following chart compares these top content management systems (CMSs):
294295

295296
News Publishing:The New York Observer
296297

297-
* - **Installation**
298+
* - Installation
298299
- Drupal Installation Forum
299300
- WordPress Installation Forum

0 commit comments

Comments
 (0)