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

Renamed a bunch of cached_robot to cached_robot_model in PyBulletClient #428

Merged
merged 2 commits into from
Jun 14, 2024

Conversation

yck011522
Copy link
Contributor

@yck011522 yck011522 commented May 30, 2024

The existing naming convention calling the cached robot_model as robot is very confusing. I renamed it to explicitly say cached_robot_model.

This is a breaking change for people who directly access the cached model, but I doubt anyone is doing that now.

  • PybulletClient.get_cached_robot to PybulletClient.get_cached_robot_model
  • PybulletClient.ensure_cached_robot to PybulletClient.ensure_cached_robot_model.
  • PybulletClient.ensure_cached_robot_geometry to PybulletClient.ensure_cached_robot_model_geometry.
  • PybulletClient.cache_robot to PybulletClient.cache_robot_model.

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas_fab.robots.CollisionMesh.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

@yck011522 yck011522 changed the base branch from remove_planner_call_magic to main May 30, 2024 18:11
@yck011522 yck011522 changed the base branch from main to remove_planner_call_magic June 14, 2024 11:32
Base automatically changed from remove_planner_call_magic to main June 14, 2024 11:38
Copy link
Member

@gonzalocasas gonzalocasas left a comment

Choose a reason for hiding this comment

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

LGTM

@yck011522 yck011522 merged commit c6ef2c0 into main Jun 14, 2024
13 checks passed
@yck011522 yck011522 deleted the patch_rename_cached_robot branch June 17, 2024 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants