phynexis-deps/pybind11
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add class doc string to native_enum (#5617)

Browse Source 
* add class doc string to native_enum

* adapt doc argument name

* fix test, make class enum doc None by default

* fix other python versions?

* make clang-tidy happy

* rename 'enum_doc' to 'class_doc'

* update documentation

* [skip ci] Polish changed documentation (mostly done by ChatGPT).

---------

Co-authored-by: Bryn Lloyd <12702862+dyollb@users.noreply.github.com>
Co-authored-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>
This commit is contained in:
Bryn Lloyd
2025-04-14 23:19:06 -07:00
committed by GitHub
co-authored by Bryn Lloyd Ralf W. Grosse-Kunstleve
parent b3bb31ca51
commit 3c586340fb
5 changed files with 33 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/test_native_enum.cpp
+3 -3
View File
@@ -76,7 +76,7 @@ PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE)
TEST_SUBMODULE(native_enum, m) {
using namespace test_native_enum;
py::native_enum<smallenum>(m, "smallenum", "enum.IntEnum")
py::native_enum<smallenum>(m, "smallenum", "enum.IntEnum", "doc smallenum")
.value("a", smallenum::a)
.value("b", smallenum::b)
.value("c", smallenum::c)
@@ -89,7 +89,7 @@ TEST_SUBMODULE(native_enum, m) {
.value("blue", color::blue)
.finalize();
py::native_enum<altitude>(m, "altitude")
py::native_enum<altitude>(m, "altitude", "enum.Enum")
.value("high", altitude::high)
.value("low", altitude::low)
.finalize();
@@ -189,7 +189,7 @@ TEST_SUBMODULE(native_enum, m) {
py::native_enum<fake>(m, "fake_double_registration_native_enum", "enum.IntEnum")
.value("x", fake::x)
.finalize();
py::native_enum<fake>(m, "fake_double_registration_native_enum");
py::native_enum<fake>(m, "fake_double_registration_native_enum", "enum.Enum");
});
m.def("native_enum_name_clash", [](py::module_ &m) {