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.

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

[py examples] Fix signatures to use Python types (not C++) #21918

Conversation

jwnimmer-tri
Copy link
Collaborator

@jwnimmer-tri jwnimmer-tri commented Sep 16, 2024

Towards #17520.

The best place to see the resulting effects is the docs. Here's one example of broken docs / types: AcrobotPlant.get_parameters. After this PR, the docs would use correct names for the types, with xref hyperlinks, etc.


This change is Reviewable

Adjust bindings to follow topological order, so that function
signatures can look up their requisite python types.
@jwnimmer-tri jwnimmer-tri added priority: high status: single reviewer ok https://drake.mit.edu/reviewable.html release notes: fix This pull request contains fixes (no new features) labels Sep 16, 2024
@jwnimmer-tri
Copy link
Collaborator Author

jwnimmer-tri commented Sep 17, 2024

+@RussTedrake for both reviews, please? Mostly so that you stay up-to-date with the latest bindings news.

@jwnimmer-tri
Copy link
Collaborator Author

@drake-jenkins-bot retest this please

+@ggould-tri for both reviews per schedule, please.

Copy link
Contributor

@ggould-tri ggould-tri left a comment

Choose a reason for hiding this comment

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

:lgtm_strong: Oh, that's really nice. Actual links for the return types!

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: :shipit: complete! all discussions resolved, LGTM from assignee ggould-tri(platform)

@jwnimmer-tri jwnimmer-tri merged commit 3b46257 into RobotLocomotion:master Oct 1, 2024
9 checks passed
@jwnimmer-tri jwnimmer-tri deleted the pybind11-check-signature-infection-planning-examples branch October 1, 2024 18:34
RussTedrake pushed a commit to RussTedrake/drake that referenced this pull request Dec 15, 2024
…motion#21918)

Adjust bindings to follow topological order, so that function
signatures can look up their requisite python types.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: medium release notes: fix This pull request contains fixes (no new features) status: single reviewer ok https://drake.mit.edu/reviewable.html
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants