aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/language/extensions
diff options
context:
space:
mode:
authorThéo Zimmermann2020-11-14 18:44:57 +0100
committerEmilio Jesus Gallego Arias2020-11-18 16:25:00 +0100
commitca42305f1ed1699065cffdef7d96bf5fcc0069be (patch)
treeb72fb82071db98d6ab2c1b52f22e57e1c1befc9f /doc/sphinx/language/extensions
parent3b479357d8c5c1a655b2b8257f14a8cafe7621fc (diff)
Review commit: improving the doc of boolean attributes.
Diffstat (limited to 'doc/sphinx/language/extensions')
-rw-r--r--doc/sphinx/language/extensions/canonical.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/sphinx/language/extensions/canonical.rst b/doc/sphinx/language/extensions/canonical.rst
index ec3e3e8aa6..f7ce7f1c6c 100644
--- a/doc/sphinx/language/extensions/canonical.rst
+++ b/doc/sphinx/language/extensions/canonical.rst
@@ -87,7 +87,8 @@ in :ref:`canonicalstructures`; here only a simple example is given.
If a same field occurs in several canonical structures, then
only the structure declared first as canonical is considered.
-.. attr:: canonical
+.. attr:: canonical{? = {| yes | no } }
+ :name: canonical
This boolean attribute can decorate a :cmd:`Definition` or
:cmd:`Let` command. It is equivalent to having a :cmd:`Canonical
@@ -106,7 +107,7 @@ in :ref:`canonicalstructures`; here only a simple example is given.
#[canonical=no] Prf_equiv : equivalence Carrier Equal
- See :ref:`canonicalstructures` for a more realistic example.
+ See :ref:`hierarchy_of_structures` for a more realistic example.
.. cmd:: Print Canonical Projections {* @reference }
@@ -245,6 +246,8 @@ for each component of the pair. The declaration associates to the key ``*``
relation ``pair_eq`` whenever the type constructor ``*`` is applied to two
types being themselves in the ``EQ`` class.
+.. _hierarchy_of_structures:
+
Hierarchy of structures
----------------------------