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

Fixed typo in gz sim python api #2578

Merged
merged 3 commits into from
Sep 5, 2024
Merged

Conversation

ahcorde
Copy link
Contributor

@ahcorde ahcorde commented Sep 2, 2024

🦟 Bug fix

Fixes #

Summary

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@ahcorde ahcorde self-assigned this Sep 2, 2024
@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Sep 2, 2024
arjo129
arjo129 previously requested changes Sep 2, 2024
Copy link
Contributor

@arjo129 arjo129 left a comment

Choose a reason for hiding this comment

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

I'm a bit torn by this change. On one hand given that we have released this, wouldn't this change break the API? Shouldn't we do a deprecation first?

On the other given how long its taken for this bug to be reported, maybe its fine to just go ahead and change the name.

@@ -94,7 +94,7 @@ void defineSimJoint(py::object module)
py::arg("ecm"),
py::arg("limits"),
"Set the effort limits on a joint axis.")
.def("set_position_imits", &gz::sim::Joint::SetPositionLimits,
.def("set_position_limits", &gz::sim::Joint::SetPositionLimits,
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't we be deprecating this instead of removing it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@azeey opinions here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I think we should deprecate the old function and add the new one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@azeey this is wrong in older versions, what should we do?

Signed-off-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Alejandro Hernández Cordero <[email protected]>
@ahcorde ahcorde changed the base branch from gz-sim8 to gz-sim9 September 4, 2024 15:31
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

LGTM!

@ahcorde ahcorde added 🏛️ ionic Gazebo Ionic and removed 🎵 harmonic Gazebo Harmonic labels Sep 5, 2024
@ahcorde ahcorde enabled auto-merge (squash) September 5, 2024 12:30
@ahcorde ahcorde merged commit 518cc31 into gz-sim9 Sep 5, 2024
10 checks passed
@ahcorde ahcorde deleted the ahcorde/sim8/fix_python_typo branch September 5, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏛️ ionic Gazebo Ionic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants