aboutsummaryrefslogtreecommitdiff
path: root/doc/tools/coqrst
diff options
context:
space:
mode:
authorJim Fehrle2019-12-18 23:23:34 -0800
committerJim Fehrle2019-12-28 12:34:47 -0800
commit7b143ed46ab2b1b804b834b59533bef5960be9bc (patch)
tree97736e1de02a980f21880f4466009707e71821f8 /doc/tools/coqrst
parentbdb5150669d5ac972d3d2b3c9cc2045e77dc9ad5 (diff)
Convert productionlists to prodns
Diffstat (limited to 'doc/tools/coqrst')
-rw-r--r--doc/tools/coqrst/coqdomain.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/tools/coqrst/coqdomain.py b/doc/tools/coqrst/coqdomain.py
index b9faeacad7..1f9178f4b6 100644
--- a/doc/tools/coqrst/coqdomain.py
+++ b/doc/tools/coqrst/coqdomain.py
@@ -403,13 +403,12 @@ class TableObject(NotationObject):
class ProductionObject(CoqObject):
r"""A grammar production.
- Use prodn to document individual grammar productions instead of Sphinx
+ Use ``.. prodn`` to document grammar productions instead of Sphinx
`production lists
<http://www.sphinx-doc.org/en/stable/markup/para.html#directive-productionlist>`_.
prodn displays multiple productions together with alignment similar to ``.. productionlist``,
- i.e. displayed in 3 columns, however
- unlike ``.. productionlist``\ s, this directive accepts notation syntax.
+ however unlike ``.. productionlist``\ s, this directive accepts notation syntax.
Example::
@@ -418,7 +417,8 @@ class ProductionObject(CoqObject):
| second_production
The first line defines "occ_switch", which must be unique in the document. The second
- references but doesn't define "term". The third form is for continuing the
+ references and expands the definition of "term", whose main definition is elsewhere
+ in the document. The third form is for continuing the
definition of a nonterminal when it has multiple productions. It leaves the first
column in the output blank.