diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 6c230ca56d..1dd58efbbd 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -1498,7 +1498,8 @@ member should be included in the documentation by using the following event: :param obj_type: the type of the object which the docstring belongs to (one of ``'module'``, ``'class'``, ``'exception'``, ``'function'``, ``'decorator'``, ``'method'``, ``'property'``, ``'attribute'``, ``'data'``, or ``'type'``) - :param name: the fully qualified name of the object + :param name: the unqualified name of the member within the namespace of the + object being documented :param obj: the object itself :param skip: a boolean indicating if autodoc will skip this member if the user handler does not override the decision