Skip to content

Enum values docstrings#248

Open
dyollb wants to merge 3 commits into
pybind:mainfrom
dyollb:enum-values-docstrings
Open

Enum values docstrings#248
dyollb wants to merge 3 commits into
pybind:mainfrom
dyollb:enum-values-docstrings

Conversation

@dyollb

@dyollb dyollb commented Apr 13, 2025

Copy link
Copy Markdown
Contributor

fix merge conflicts from #225

Close #225

@ax3l ax3l added bug Something isn't working enhancement New feature or request and removed bug Something isn't working labels Jan 22, 2026
@ax3l ax3l requested review from ax3l, skarndev and virtuald January 22, 2026 08:17
@ax3l

ax3l commented Jan 22, 2026

Copy link
Copy Markdown
Contributor

@gentlegiantJGC do you like to help with the review of this one?

@gentlegiantJGC

gentlegiantJGC commented Jan 22, 2026

Copy link
Copy Markdown
Contributor

Something is wrong with the tests. I can't tell if the code is not working or if the tests are wrong.

This bit just looks like the docstring in the tests are wrong.

-      Green
+      Green : Green color

I don't understand this diff. Which is the ground truth and which is the generated? It doesn't seem to match the test files.
It is adding docstrings to the exported module level variables. Is this correct?

 Blue: ConsoleForegroundColor  # value = <ConsoleForegroundColor.Blue: 34>
+"""
+Blue color
+"""

We should also add tests for py::native_enum which I assume behaves a little different to the old enum.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants