aboutsummaryrefslogtreecommitdiff
path: root/doc/markup.rst
diff options
context:
space:
mode:
authorHécate Moonlight <Kleidukos@users.noreply.github.com>2021-02-07 16:18:10 +0100
committerGitHub <noreply@github.com>2021-02-07 16:18:10 +0100
commita10d042ac76c990764250244ac801db16858b6ee (patch)
tree40f8bc9066d9d96fa00163b10ac85d7645ad01d2 /doc/markup.rst
parenta2f9f297d17059b3fc68ce4a245702278a5d8340 (diff)
parentc31c156422785751e33c9a7a4f021ac8da77d364 (diff)
Merge pull request #1319 from alexbiehl/alex/compat
Backward compat: Add support for labeled module references
Diffstat (limited to 'doc/markup.rst')
-rw-r--r--doc/markup.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/markup.rst b/doc/markup.rst
index 8935b765..c0b08a40 100644
--- a/doc/markup.rst
+++ b/doc/markup.rst
@@ -982,6 +982,11 @@ is valid before turning it into a link but unlike with identifiers,
whether the module is in scope isn't checked and will always be turned
into a link.
+It is also possible to specify alternate text for the generated link
+using syntax analogous to that used for URLs: ::
+
+ -- | This is a reference to [the main module]("Module.Main").
+
Itemized and Enumerated Lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~