summaryrefslogtreecommitdiff
path: root/doc/usage/extensions/viewcode.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/usage/extensions/viewcode.rst')
-rw-r--r--doc/usage/extensions/viewcode.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/usage/extensions/viewcode.rst b/doc/usage/extensions/viewcode.rst
index cc7dbb07a..d3c3c44fb 100644
--- a/doc/usage/extensions/viewcode.rst
+++ b/doc/usage/extensions/viewcode.rst
@@ -41,10 +41,9 @@ Configuration
.. confval:: viewcode_follow_imported_members
- If this is ``True``, viewcode extension will follow alias objects that
- imported from another module such as functions, classes and attributes. As
- side effects, this option else they produce nothing. The default is
- ``True``.
+ If this is ``True``, viewcode extension will emit
+ :event:`viewcode-follow-imported` event to resolve the name of the module
+ by other extensions. The default is ``True``.
.. versionadded:: 1.3