File tree 1 file changed +9
-0
lines changed 1 file changed +9
-0
lines changed Original file line number Diff line number Diff line change @@ -324,6 +324,15 @@ The class ``options`` allows you to selectively suppress auto-generated signatur
324
324
m.def("add", [](int a, int b) { return a + b; }, "A function which adds two numbers");
325
325
}
326
326
327
+ pybind11 also appends all members of an enum to the resulting enum docstring,
328
+ this default behaviour can be disabled by using the ``disable_enum_members_docstring() ``
329
+ function of the ``options `` classe.
330
+
331
+ With ``disable_user_defined_docstrings() `` all user defined docstrings of
332
+ ``module_::def() ``, ``class_::def() `` and ``enum_() `` are discarded, but the
333
+ function signatures and enum members are included in the docstring, unless they
334
+ are disabled seperately.
335
+
327
336
Note that changes to the settings affect only function bindings created during the
328
337
lifetime of the ``options `` instance. When it goes out of scope at the end of the module's init function,
329
338
the default settings are restored to prevent unwanted side effects.
You can’t perform that action at this time.
0 commit comments