aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/tools
diff options
context:
space:
mode:
authorGravatar Clément Pit-Claudel <clement.pitclaudel@live.com>2018-05-05 12:25:46 -0400
committerGravatar Clément Pit-Claudel <clement.pitclaudel@live.com>2018-05-15 12:05:44 -0400
commite266976abc8c170c1e4bf1c98629c190b844f1ab (patch)
tree0b6eb0e4640dccecd064f3ea534350c7fcef24f8 /doc/tools
parentb053c575e48c25631cfa6a6a8ed33b6b93c95ea7 (diff)
[doc] More feedback on doc writer guide
Co-Authored-By: @Zimmi48
Diffstat (limited to 'doc/tools')
-rw-r--r--doc/tools/coqrst/coqdomain.py3
1 files changed, 1 insertions, 2 deletions
diff --git a/doc/tools/coqrst/coqdomain.py b/doc/tools/coqrst/coqdomain.py
index f8bb113a7..606d725bf 100644
--- a/doc/tools/coqrst/coqdomain.py
+++ b/doc/tools/coqrst/coqdomain.py
@@ -829,8 +829,7 @@ class IndexXRefRole(XRefRole):
return title, target
def GrammarProductionRole(typ, rawtext, text, lineno, inliner, options={}, content=[]):
- """A Sphinx role to format grammar productions not included in a
- `productionlist` directive.
+ """A grammar production not included in a ``productionlist`` directive.
Useful to informally introduce a production, as part of running text.