summaryrefslogtreecommitdiff
path: root/doc/extdev/appapi.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/extdev/appapi.rst')
-rw-r--r--doc/extdev/appapi.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index f9b43560f..d65f91a54 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -442,7 +442,8 @@ handlers to the events. Example:
Emitted after the environment has determined the list of all added and
changed files and just before it reads them. It allows extension authors to
reorder the list of docnames (*inplace*) before processing, or add more
- docnames that Sphinx did not consider changed.
+ docnames that Sphinx did not consider changed (but never add any docnames
+ that are not in ``env.found_docs``).
You can also remove document names; do this with caution since it will make
Sphinx treat changed files as unchanged.