summaryrefslogtreecommitdiff
path: root/doc/extdev/appapi.rst
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2018-05-29 01:25:46 +0900
committerGitHub <noreply@github.com>2018-05-29 01:25:46 +0900
commit72011465ade6a20a33df2daf91d30f287dfeb662 (patch)
treefae712952e334eba7a354ba1982a0947401e5b9b /doc/extdev/appapi.rst
parentd9df3b4b471fa124dbe68fb3f6263afd0076c846 (diff)
parent814abfd020551e9e0d586ed45d0fdaeb9eb8679e (diff)
downloadsphinx-git-72011465ade6a20a33df2daf91d30f287dfeb662.tar.gz
Merge pull request #5020 from tk0miya/5018_update_docs
Fix #5018: wrong signature of env-merge-info and env-check-consistency
Diffstat (limited to 'doc/extdev/appapi.rst')
-rw-r--r--doc/extdev/appapi.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 4989a1034..cb61c0d7f 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -269,7 +269,7 @@ handlers to the events. Example:
Here is the place to replace custom nodes that don't have visitor methods in
the writers, so that they don't cause errors when the writers encounter them.
-.. event:: env-merge-info (env, docnames, other)
+.. event:: env-merge-info (app, env, docnames, other)
This event is only emitted when parallel reading of documents is enabled. It
is emitted once for every subprocess that has read some documents.
@@ -303,7 +303,7 @@ handlers to the events. Example:
.. versionchanged:: 1.3
The handlers' return value is now used.
-.. event:: env-check-consistency (env)
+.. event:: env-check-consistency (app, env)
Emitted when Consistency checks phase. You can check consistency of
metadata for whole of documents.