Skip to content

Commit 8631762

Browse files
committed
updated per review feedback
1 parent c903725 commit 8631762

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

documentation/style-guide.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -193,20 +193,19 @@ the second mention is more appropriate for a link. Some units are long enough
193193
to have a few repeated links. Use judgement to decide when a link will help
194194
the reader.
195195

196-
We use the `linklint Sphinx extension`__ to suppress two kinds of excessive
197-
links: references in a section to itself and duplicate references in a
198-
paragraph. Previously, editors had to carefully use an exclamation mark in a
199-
Sphinx reference (``:func:`!map```) to prevent such links.
200-
201-
__ https://pypi.org/project/linklint/
196+
We use the :pypi:`linklint Sphinx extension <linklint>` to suppress two kinds
197+
of excessive links: references in a section to itself and duplicate references
198+
in a paragraph. Previously, editors had to carefully use an exclamation mark
199+
in a Sphinx reference (``:func:`!map```) to prevent such links.
202200

203201
Do not use links in section headers. They distract from the title of the
204202
section. The term will be mentioned in the paragraph text and can be linked
205203
from there.
206204

207205
Sphinx automatically adds links to references, and provides a way to
208206
suppress the link. Using roles like ``:func:`map``` will link to the
209-
documentation for ``map``. You can suppress the link while keeping the
207+
documentation for ``map``. If automatic link suppression isn't enough,
208+
you can suppress the link while keeping the
210209
semantic presentation of the function name by adding an exclamation point
211210
prefix: ``:func:`!map```. See :ref:`roles` for more details.
212211

0 commit comments

Comments
 (0)