Skip to content

Commit 1be108a

Browse files
committed
Recommend anonymous hyperlinks
1 parent 0983512 commit 1be108a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

documentation/markup.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ attribute definitions ``.. attribute: `attr-name``` :ref:`inform
2828
attribute references ``:attr:`attr-name``` :ref:`roles`
2929
reference labels ``.. _label-name:`` :ref:`doc-ref-role`
3030
internal references ``:ref:`label-name``` :ref:`doc-ref-role`
31-
external links ```Link text <https://example.com>`_`` :ref:`hyperlinks`
31+
external links ```Link text <https://example.com>`__`` :ref:`hyperlinks`
3232
roles w/ custom text ``:role:`custom text <target>``` :ref:`roles`
3333
roles w/ only last part ``:role:`~hidden.hidden.visible``` :ref:`roles`
3434
roles w/o link ``:role:`!target``` :ref:`roles`
@@ -185,9 +185,12 @@ Hyperlinks
185185
External links
186186
^^^^^^^^^^^^^^
187187

188-
Use ```Link text <http://target>`_`` for inline web links. If the link text
188+
Use ```Link text <https://example.com>`__`` for inline web links. If the link text
189189
should be the web address, you don't need special markup at all, the parser
190-
finds links and mail addresses in ordinary text.
190+
finds links and mail addresses in ordinary text. Prefer anonymous hyperlinks
191+
(with a double underscore) over named hyperlinks (with a single underscore)
192+
to avoid target name clashes.
193+
191194

192195
Internal links
193196
^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)