aboutsummaryrefslogtreecommitdiff
path: root/doc/tools
diff options
context:
space:
mode:
authorThéo Zimmermann2020-06-05 13:11:02 +0200
committerThéo Zimmermann2020-06-05 13:14:54 +0200
commit20cee609d1e22a9f2942f63c6e1a6469c28d6e55 (patch)
tree46b3accb294d1126d25fdcf16d70c68c657e14b6 /doc/tools
parent73d400a5f7dafb448aaae188dba048064456945c (diff)
Fix comment.
Co-authored-by: Jim Fehrle <jim.fehrle@gmail.com> Remove note about Sphinx tradition.
Diffstat (limited to 'doc/tools')
-rw-r--r--doc/tools/coqrst/coqdomain.py11
1 files changed, 1 insertions, 10 deletions
diff --git a/doc/tools/coqrst/coqdomain.py b/doc/tools/coqrst/coqdomain.py
index 5b0f87adfc..b0bbbf33b3 100644
--- a/doc/tools/coqrst/coqdomain.py
+++ b/doc/tools/coqrst/coqdomain.py
@@ -220,7 +220,7 @@ class CoqObject(ObjectDescription):
self.indexnode['entries'].append(('single', index_text, target, '', None))
def add_target_and_index(self, names, _, signode):
- """Attach a link target to `signode` and an index entries for `names`.
+ """Attach a link target to `signode` and index entries for `names`.
This is only called (from ``ObjectDescription.run``) if ``:noindex:`` isn't specified."""
if names:
for name in names:
@@ -235,15 +235,6 @@ class CoqObject(ObjectDescription):
A node may have either one signature with no name, multiple signatures
with one name per signatures, or one signature with multiple names.
-
- (That last case isn't ideal; in the Sphinx tradition, it would be better
- to have one signature per name, like this:
-
- .. cmd:: Definition …
- Fact …
- Lemma …
- …
- :name: Definition; Fact; Lemma; …)
"""
sigs = self.get_signatures()
names = self.options.get("name")