Skip to content

Commit 54fc89b

Browse files
Make minor phrasing changes to table article (#881)
* Make minor phrasing changes to table article - Avoid passive voice - More explicitly address the reader - Fix grammar and wording mistakes rdar://122293614 * Correct alignment used in spanning cells example * More minor phrasing changes to table article: - Typos/grammar fixes for two sentences --------- Co-authored-by: Pat Shaughnessy <[email protected]>
1 parent 30110b0 commit 54fc89b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Sources/docc/DocCDocumentation.docc/adding-tables-of-data.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Sloth speed | Description
1919
`supersonic` | Moves faster than the speed of sound
2020
```
2121

22-
The example markup above defines the table that's shown below. Each column is automatically sized to fit its widest cell and the table is only as wide as the sum of its columns.
22+
The example markup above defines the table that's shown below. Each column is only as wide as its widest cell and the table is only as wide as the sum of its columns.
2323

2424
Sloth speed | Description
2525
------------ | -------------------------------------
@@ -28,9 +28,9 @@ Sloth speed | Description
2828
`fast` | Moves faster than a hare
2929
`supersonic` | Moves faster than the speed of sound
3030

31-
It's not necessary to pad the cells to align the column separators (`|`). However, it may make your table _markup_ easier to read, especially for large or complex tables.
31+
You don't need to pad the cells to align the column separators (`|`). However, it might make your table _markup_ easier to read, especially for large or complex tables.
3232

33-
The same table could have been defined like below. All other examples will uses padded cells for readability.
33+
You can also define the same table with the markup that's shown below. All other examples will use padded cells for readability.
3434

3535
```md
3636
Sloth speed|Description
@@ -41,7 +41,7 @@ Sloth speed|Description
4141
`supersonic`|Moves faster than the speed of sound
4242
```
4343

44-
You can add leading and/or trailing pipes (`|`) if you find that table markup easier to read. This doesn't affect the rendered table on the page. The leading and trailing pipes _can_ be applied inconsistently for each row but doing so may make it harder to discern the structure of the table.
44+
You can add leading and/or trailing pipes (`|`) if you find that table markup easier to read. This doesn't affect the rendered table on the page. The leading and trailing pipes _can_ be applied inconsistently for each row, but doing so may make it harder to discern the structure of the table.
4545

4646
```md
4747
| Sloth speed | Description |
@@ -68,7 +68,7 @@ Leading | Center | Trailing
6868

6969
### Spanning cells across columns
7070

71-
By default, each table cell is one column wide and one row tall. To span a table cell across multiple columns, place two or more column separators (`|`) next to each other after the cell's content. If the spanning cell is the last or only element of a row, you need to add the extra trailing pipe (`|`) for that row, otherwise DocC will interpret the row as having an additional empty cell at the end. For example:
71+
By default, each table cell is one column wide and one row tall. To span a table cell across multiple columns, place two or more column separators (`|`) next to each other after the cell's content. If the spanning cell is the last or only element of a row, you need to add the extra trailing pipe (`|`) for that row, otherwise DocC interprets the row as having an additional empty cell at the end. For example:
7272

7373
@Row {
7474
@Column {
@@ -89,19 +89,19 @@ By default, each table cell is one column wide and one row tall. To span a table
8989
}
9090
}
9191

92-
> Tip: You may find it easier to discern the structure of your table from its markup if you use trailing pipes consistently when spanning cells.
92+
> Tip: You might find it easier to discern the structure of your table from its markup if you use trailing pipes consistently when spanning cells.
9393
94-
A spanning cells determines its horizontal alignment from the left-most column that it spans. Going from left to right in the example below:
94+
A spanning cell determines its horizontal alignment from the left-most column that it spans. Going from left to right in the example below:
9595

96-
- Cells "One" and "Five" uses leading alignment because they both span the first column
96+
- Cells "One" and "Five" use leading alignment because they both span the first column
9797
- Cell "Four" uses center alignment because it spans the second column
9898
- Cell "Two" uses trailing alignment because it spans the third column
9999

100100
@Row {
101101
@Column {
102102
```md
103103
Leading | Center | Trailing |
104-
------: | :----: | :------- |
104+
:------ | :----: | -------: |
105105
One || Two |
106106
Three | Four ||
107107
Five |||

0 commit comments

Comments
 (0)