Skip to content

Commit

Permalink
Improve documentation wording
Browse files Browse the repository at this point in the history
  • Loading branch information
knarfS committed Dec 2, 2022
1 parent 15f2e40 commit ede83c2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/advanced/misc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -324,12 +324,12 @@ The class ``options`` allows you to selectively suppress auto-generated signatur
m.def("add", [](int a, int b) { return a + b; }, "A function which adds two numbers");
}
pybind11 also appends all members of an enum to the resulting enum docstring,
this default behaviour can be disabled by using the ``disable_enum_members_docstring()``
pybind11 also appends all members of an enum to the resulting enum docstring.
This default behavior can be disabled by using the ``disable_enum_members_docstring()``
function of the ``options`` class.

With ``disable_user_defined_docstrings()`` all user defined docstrings of
``module_::def()``, ``class_::def()`` and ``enum_()`` are discarded, but the
``module_::def()``, ``class_::def()`` and ``enum_()`` are disabled, but the
function signatures and enum members are included in the docstring, unless they
are disabled separately.

Expand Down

0 comments on commit ede83c2

Please sign in to comment.