Skip to content

Commit 53ffe4c

Browse files
author
Chris Cho
committed
PR review fixes
1 parent 8fac4fe commit 53ffe4c

File tree

9 files changed

+36
-31
lines changed

9 files changed

+36
-31
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ package-branch = "testing"
1010
package-version = "4.4.0"
1111
package-name-org = "mongodb-org"
1212
version = "4.0"
13-
rst-title = "ReStructuredText"
13+
rst-title = "reStructuredText"
1414
rst = "reStructuredText"
1515
rst-abbrev = "RST"
1616
yaml = "Yet Another Markup Language"

source/style-guide/markup/directives/code-blocks.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ Code Examples
33
=============
44

55
As needed, use the appropriate language option for code blocks directives
6-
including the following:
6+
including the following directives:
77

88
- ``code-block``
99
- ``io-code-block``
1010
- ``literalinclude``
1111

12-
This enables syntax highlighting which makes the source code easier to
13-
interpret. The following example shows how to specify Python language
14-
syntax highlighting in a ``code-block`` directive:
12+
These directives feature syntax highlighting which makes the source code
13+
contained in them easier to interpret. The following example shows how to
14+
specify Python language syntax highlighting in a ``code-block`` directive:
1515

1616
.. code-block::
1717

source/style-guide/markup/directives/tables.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Table Directives
44

55
Use tables to format related information.
66

7-
In Snooty, you can only use the ``list-table`` directive to build tables.
7+
In Snooty, you can use only the ``list-table`` directive to build tables.
88
The ``list-table`` directive generates a formatted table from a two-level
9-
bullet list.
9+
bulleted list.
1010

11-
Learn more about the ``list-table`` directive frmo the
11+
To learn more about the ``list-table`` directive from the
1212
`{+docutils+} documentation </directives#list-table>`__.
1313

source/style-guide/markup/directives/tabs.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,8 @@ all pages that use the same tab set:
8585
- Eliminate the need for the writer to specify the tab display name
8686
(tab label)
8787

88-
Refer to the `Snooty configuration file <https://github.com/mongodb/snooty-parser/blob/master/snooty/rstspec.toml>`__
89-
to find the pre-defined tab sets. Each of the entries starts with
90-
``[directive.tabs-``.
88+
To find the pre-defined tab sets, see the `Snooty configuration file <https://github.com/mongodb/snooty-parser/blob/master/snooty/rstspec.toml>`__.
89+
Each entry starts with ``[directive.tabs-``.
9190

9291
Pre-defined tab sets require the following fields for each tab:
9392

@@ -149,8 +148,8 @@ code examples stored in different files:
149148
Defining a New Tab Set
150149
~~~~~~~~~~~~~~~~~~~~~~
151150

152-
Reach out to the {+docs-platform+} for more information on creating a new
153-
pre-defined tab set.
151+
To learn more about creating a new pre-defined tab set, contact the
152+
{+docs-platform+}.
154153

155154
Using a Custom Tab Set
156155
~~~~~~~~~~~~~~~~~~~~~~

source/style-guide/markup/format/lists.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Lists
55
Lists are body elements that organize information into adjacent blocks of
66
markup. Each level of a list must start and end with a blank line.
77

8-
Learn more about when to use lists from the :ref:`<lists>` style guide entry.
8+
To learn more about when to use lists, see the :ref:`<lists>` style guide
9+
entry.
910

1011
Unordered Lists
1112
~~~~~~~~~~~~~~~
@@ -102,8 +103,8 @@ Ordered lists append a number before each item to show a sequential order.
102103
Definition Lists
103104
~~~~~~~~~~~~~~~~
104105

105-
Definition lists specify a term and a related block that can be used to
106+
Definition lists specify a term and a related block that you can use to
106107
describe the term.
107108

108-
Learn more about definition lists from the `{+docutils+} documentation <http://www.docutils.org/docs/ref/rst/restructuredtext.html#definition-lists>`__.
109+
To learn more about definition lists, see the `{+docutils+} documentation <http://www.docutils.org/docs/ref/rst/restructuredtext.html#definition-lists>`__.
109110

source/style-guide/markup/format/roles.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
Roles
33
=====
44

5-
Roles are a type of directive that are used inline and can be used to create
6-
cross-references or apply formatting. Use them consistently to ensure
7-
uniform formatting.
5+
Roles are inline directives used to create cross-references or apply formatting.
6+
Use them consistently to ensure uniform formatting.
87

9-
Learn more about roles from the
8+
To learn more about roles, see the
109
`Sphinx documentation <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`__.
1110

1211
.. toctree::

source/style-guide/markup/format/substitutions.txt

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,19 @@
22
Substitutions
33
=============
44

5+
In Snooty, you can use variables to represent a text value in the
6+
rendered form of the documentation. These variables are called
7+
source constants. When used consistently, they help prevent inconsistencies in
8+
formatting the term and make it easy to change the value for all its
9+
occurrences.
10+
511
Source Constants
612
----------------
713

814
Source constants define substitution text for variables in {+rst+} files.
915
When building the documentation, the substitution text replaces the instances
1016
of the variables prior to {+docutils+} parser transforming the document to
11-
HTML. Source constants can be used within directives and roles.
17+
HTML. You can use source constants within directives and roles.
1218

1319
You can add or modify source constants in your documentation repository's
1420
``snooty.toml`` file in the base directory. Source constants should be
@@ -24,7 +30,7 @@ include the following line in the ``[constants]`` section:
2430

2531
mdn = "https://developer.mozilla.org/en-US/docs/MDN/"
2632

27-
To use the source constant, as shown in the following example:
33+
Use the source constant as shown in the following example:
2834

2935
.. code-block:: rst
3036

@@ -33,7 +39,7 @@ To use the source constant, as shown in the following example:
3339

3440
.. important::
3541

36-
In your {+rst+}, source constants should not contain spaces between curly
42+
In your {+rst+}, source constants shouldn't contain spaces between curly
3743
braces and plus signs as shown in the example. The spaces were
3844
intentionally added to the example to prevent the parser from substituting
3945
a value.

source/style-guide/markup/headings.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Headings and Sections
55
Headings organize information into a hierarchy of sections.
66
To set headings, add repeating characters below the heading text.
77

8-
Learn more about headings from the
8+
To learn more about headings, see the
99
`Sphinx documentation <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections>`__.
1010

1111
Heading Markup Rules
@@ -48,7 +48,7 @@ To avoid errors in your header markup syntax, stick to the following rules:
4848
~~~~~~~~~~~~~~~~~~~
4949

5050
- Make the underline as long as the text above it. If you use a source constant
51-
in the header, you need the line to match the length of the resolved text.
51+
in the header, the underline must match the length of the resolved text.
5252

5353
.. list-table::
5454
:header-rows: 1

source/style-guide/markup/inline.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ Inline Markup
1111
Inline markup, also known as roles, specify how the enclosed text should be
1212
interpreted or rendered.
1313

14-
Learn more about roles from the `{+docutils+} documentation <http://www.docutils.org/docs/ref/rst/roles.html>`__.
14+
To learn more about roles, see the `{+docutils+} documentation <http://www.docutils.org/docs/ref/rst/roles.html>`__.
1515

16-
{+sphinx+} provides an extended set of roles. Learn more about these roles
17-
from the `Sphinx documentation <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`__.
16+
{+sphinx+} provides an extended set of roles. To learn more about the
17+
extended roles, see the `Sphinx documentation <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`__.
1818

1919
Font Formatting Roles
2020
---------------------
2121

22-
These roles control how the font of the enclosed text is rendered.
22+
These roles control how the font of the enclosed text renders.
2323

24-
Learn more about when to use these roles from the style guide section on
24+
To learn more about when to use these roles, see the style guide section on
2525
:ref:`<text-formatting>`.
2626

2727
- To **strongly emphasize** or **bold** text, use two asterisks on
@@ -91,7 +91,7 @@ Use the following guidelines to avoid errors in font formatting roles:
9191

9292
**``bold code``**
9393

94-
- When applying a text formatting role to the middle of a word, use a backslash
94+
- When you apply a text formatting role to the middle of a word, use a backslash
9595
and space character on both sides of the formatted text.
9696

9797
.. list-table::

0 commit comments

Comments
 (0)