File tree Expand file tree Collapse file tree 1 file changed +7
-5
lines changed
Expand file tree Collapse file tree 1 file changed +7
-5
lines changed Original file line number Diff line number Diff line change @@ -193,16 +193,18 @@ the second mention is more appropriate for a link. Some units are long enough
193193to have a few repeated links. Use judgement to decide when a link will help
194194the reader.
195195
196- Do not use a link when the link would point to the current unit. It's natural
197- to use the name of a function in the documentation for the function, but a link
198- on that function name that simply reloads the section the user is already
199- reading is useless and distracting.
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/
200202
201203Do not use links in section headers. They distract from the title of the
202204section. The term will be mentioned in the paragraph text and can be linked
203205from there.
204206
205- Sphinx provides ways to automatically add links to references, and a way to
207+ Sphinx automatically adds links to references, and a way to
206208suppress the link. Using roles like ``:func:`map` `` will link to the
207209documentation for ``map ``. You can suppress the link while keeping the
208210semantic presentation of the function name by adding an exclamation point
You can’t perform that action at this time.
0 commit comments