Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Render py::bool_ and py::float_ without _ in docstrings #3622

Merged
merged 2 commits into from
Jan 16, 2022
Merged

Render py::bool_ and py::float_ without _ in docstrings #3622

merged 2 commits into from
Jan 16, 2022

Conversation

sizmailov
Copy link
Contributor

@sizmailov sizmailov commented Jan 15, 2022 •
edited by henryiii
Loading

Description

py::bool_/py::float_ used to be rendered as bool_/float_ in docstrings

Suggested changelog entry:

* Render ``py::bool_`` and ``py::float_`` as ``bool`` and ``float`` respectively

@sizmailov sizmailov changed the title Render py::bool_ as bool in docstrings Render py::bool_ and py::float_ without _ in docstrings Jan 15, 2022
@sizmailov sizmailov force-pushed the fix-py-bool-docstring-name branch from d4e6f86 to 22ca58c Compare January 15, 2022 17:07
@sizmailov sizmailov mentioned this pull request Jan 15, 2022
Closed
rwgk
rwgk approved these changes Jan 15, 2022
View reviewed changes
Copy link
Collaborator

@rwgk rwgk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Sergei!

(I'm astonished nobody took care of this before.)

@rwgk rwgk requested a review from Skylion007 January 15, 2022 17:35
henryiii
henryiii approved these changes Jan 16, 2022
View reviewed changes
Copy link
Collaborator

@henryiii henryiii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable to me.

@rwgk
Copy link
Collaborator

rwgk commented Jan 16, 2022

I'll run this through the Google global testing (who knows ...).

@rwgk
Copy link
Collaborator

rwgk commented Jan 16, 2022

I'll run this through the Google global testing (who knows ...).

No issues!
I'll try to merge this tomorrow (when I have time to tend to hiccups, if any).

@rwgk rwgk merged commit 5194855 into pybind:master Jan 16, 2022
@github-actions github-actions bot added the needs changelog Possibly needs a changelog entry label Jan 16, 2022
@henryiii henryiii removed the needs changelog Possibly needs a changelog entry label Feb 2, 2022
@rwgk rwgk mentioned this pull request Feb 10, 2023
Closed
@sizmailov sizmailov deleted the fix-py-bool-docstring-name branch September 3, 2023 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rwgk rwgk rwgk approved these changes

@henryiii henryiii henryiii approved these changes

@Skylion007 Skylion007 Awaiting requested review from Skylion007

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sizmailov @rwgk @henryiii