Skip to content

Commit fe6362d

Browse files
author
Chris Cho
authored
Merge pull request #133 from sarahsimpers/DOCSP-26883
(DOCSP-26883) Fixes rST formatting error that broke See Also notes
2 parents 6ce47ae + dfffe28 commit fe6362d

28 files changed

+197
-65
lines changed

source/redirects.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ deleted or renamed, a redirect rule should be created.
1717
The master redirect file for a project generally exists under
1818
``config/redirects``.
1919

20-
.. seealso:: :doc:`/tutorials/version-bumping`
20+
.. seealso::
21+
22+
:doc:`/tutorials/version-bumping`
2123

2224
Redirect Syntax
2325
---------------

source/reference/eval.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@ For example:
1717
:eval:`int((datetime.datetime.now() - datetime.datetime(2010, 1, 1)).days / 365.2425)`
1818
years since 2010.
1919

20-
.. seealso:: `eval.py <https://github.com/mongodb/docs-tools/blob/master/sphinxext/eval.py>`__
20+
.. seealso::
21+
22+
`eval.py <https://github.com/mongodb/docs-tools/blob/master/sphinxext/eval.py>`__

source/reference/template.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,6 @@ use:
7878

7979
Defaults to the 3, or the ``~`` character.
8080

81-
.. seealso:: `template.py <https://github.com/mongodb/docs-tools/blob/master/sphinxext/template.py>`__
81+
.. seealso::
82+
83+
`template.py <https://github.com/mongodb/docs-tools/blob/master/sphinxext/template.py>`__

source/reference/test-code.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,6 @@ For example:
2323
}
2424
)
2525

26-
.. seealso:: `rst-tools <https://github.com/10gen/rst-tools>`__
26+
.. seealso::
27+
28+
`rst-tools <https://github.com/10gen/rst-tools>`__

source/reference/xmlrole.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,6 @@ For example:
4747
:xml:`<strong>See: <link target="https://example.com">An Example Link</link></strong>`
4848

4949

50-
.. seealso:: `xmlrole.py <https://github.com/mongodb/docs-tools/blob/master/sphinxext/xmlrole.py>`__
50+
.. seealso::
51+
52+
`xmlrole.py <https://github.com/mongodb/docs-tools/blob/master/sphinxext/xmlrole.py>`__

source/style-guide/includes/terms/b.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,9 @@ B
222222
on a UI, use :term:`lower left` and :term:`lower right
223223
<lower left>` instead.
224224

225-
.. seealso:: :term:`left` and :term:`right`
225+
.. seealso::
226+
227+
:term:`left` and :term:`right`
226228

227229
box
228230
Use *box* instead of *field* to describe a box (including a text
@@ -297,4 +299,6 @@ B
297299
-
298300

299301
by using
300-
.. seealso:: :term:`using`, :term:`by using`, :term:`with`
302+
.. seealso::
303+
304+
:term:`using`, :term:`by using`, :term:`with`

source/style-guide/includes/terms/c.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,9 @@ C
135135
dialog box, or file. Use *close* to refer to the **Close**
136136
button or closing a window, dialog box, or file.
137137

138-
.. seealso:: :term:`collapse`, :term:`expand` and :term:`exit`
138+
.. seealso::
139+
140+
:term:`collapse`, :term:`expand` and :term:`exit`
139141

140142
co (prefix)
141143
Don't hyphenate words that begin with the prefix *co*, such as

source/style-guide/includes/terms/d.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ D
9494
option, or button. Don't use :term:`disabled`, :term:`grayed`, or
9595
:term:`grayed out <grayed>`.
9696

97-
.. seealso:: :term:`unavailable`
97+
.. seealso::
98+
99+
:term:`unavailable`
98100

99101
.. list-table::
100102
:widths: 50 50
@@ -163,7 +165,9 @@ D
163165
to express the action of quickly touching and releasing an item on
164166
the device screen twice in quick succession. Always hyphenate.
165167

166-
.. seealso:: :term:`tap`
168+
.. seealso::
169+
170+
:term:`tap`
167171

168172
.. list-table::
169173
:widths: 50 50

source/style-guide/includes/terms/e.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ E
99
*above*) when referring to product releases and version numbers.
1010
Don't use *earlier* or *later* to refer to information in text.
1111

12-
.. seealso:: :term:`following`, :term:`preceding`
12+
.. seealso::
13+
14+
:term:`following`, :term:`preceding`
1315

1416
.. list-table::
1517
:widths: 50 50
@@ -171,7 +173,9 @@ E
171173
You can use *message* by itself as a general term to refer to an
172174
error, informational, or warning message.
173175

174-
.. seealso:: :ref:`error-message-guidelines`
176+
.. seealso::
177+
178+
:ref:`error-message-guidelines`
175179

176180
.. list-table::
177181
:widths: 50 50
@@ -194,7 +198,9 @@ E
194198
example). Precede a limited list of examples with *such as*, or
195199
list all specific items.
196200

197-
.. seealso:: :ref:`avoid-obscure-words`
201+
.. seealso::
202+
203+
:ref:`avoid-obscure-words`
198204

199205
Ethernet
200206
Capitalize.

source/style-guide/includes/terms/g.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ G
3333
options, or buttons on an interface, use *unavailable* (not
3434
*dimmed* or *gray* or :term:`grayed out <grayed>`).
3535

36-
.. seealso:: :term:`dimmed`
36+
.. seealso::
37+
38+
:term:`dimmed`
3739

3840
.. list-table::
3941
:widths: 50 50

0 commit comments

Comments
 (0)