aboutsummaryrefslogtreecommitdiff
path: root/doc/markup.rst
diff options
context:
space:
mode:
authorSimon Jakobi <simon.jakobi@gmail.com>2018-07-20 15:06:06 +0200
committerSimon Jakobi <simon.jakobi@gmail.com>2018-07-20 15:09:05 +0200
commit88aac156228f94e17b81d8bcfb961ddcde878489 (patch)
tree54e4f565c6a893c32b8fb6532291142865f12f58 /doc/markup.rst
parent051427bce8e0e42610b6a6332e121aebf7bf244b (diff)
Additional tests for the identifier parser (#816)
* Add tests for the identifier parser * docs: Clarify how to delimit identifiers (cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)
Diffstat (limited to 'doc/markup.rst')
-rw-r--r--doc/markup.rst13
1 files changed, 4 insertions, 9 deletions
diff --git a/doc/markup.rst b/doc/markup.rst
index 1a278da3..a9878837 100644
--- a/doc/markup.rst
+++ b/doc/markup.rst
@@ -859,10 +859,13 @@ Hyperlinked Identifiers
~~~~~~~~~~~~~~~~~~~~~~~
Referring to a Haskell identifier, whether it be a type, class,
-constructor, or function, is done by surrounding it with single quotes: ::
+constructor, or function, is done by surrounding it with a combination
+of single quotes and backticks. For example: ::
-- | This module defines the type 'T'.
+```T``` is also ok. ``'T``` and ```T'`` are accepted but less common.
+
If there is an entity ``T`` in scope in the current module, then the
documentation will hyperlink the reference in the text to the definition
of ``T`` (if the output format supports hyperlinking, of course; in a
@@ -890,14 +893,6 @@ apostrophes themselves: to hyperlink ``foo'`` one would simply type
``'foo''``. To hyperlink identifiers written in infix form, simply put
them in quotes as always: ``'`elem`'``.
-For compatibility with other systems, the following alternative form of
-markup is accepted [3]_: ```T'``.
-
-.. [3]
- We chose not to use this as the primary markup for identifiers
- because strictly speaking the ````` character should not be used as a
- left quote, it is a grave accent.
-
Emphasis, Bold and Monospaced Text
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~