mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-24 22:27:52 -05:00
Clarify the name passed to autodoc-skip-member (#14629)
This commit is contained in:
1 parent
ef672916c8
commit
934d19e900
1 file changed
+2
-1
@@ -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
|
||||
|
||||
Reference in new issue
Block a user