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

Refactoring of compas_robots to COMPAS 2.0 and various updates to prepare for release #1

Merged
merged 34 commits into from
Jan 11, 2024

Conversation

gonzalocasas
Copy link
Member

@gonzalocasas gonzalocasas commented Dec 20, 2023

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 have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

@gonzalocasas gonzalocasas marked this pull request as ready for review December 21, 2023 08:55
@gonzalocasas
Copy link
Member Author

ah wait.. hold on the review, the build is failing horribly for some reason...

@gonzalocasas gonzalocasas marked this pull request as draft January 3, 2024 22:27
@gonzalocasas gonzalocasas marked this pull request as ready for review January 4, 2024 00:11
Copy link
Member

@chenkasirer chenkasirer left a comment

Choose a reason for hiding this comment

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

LGTM + left some comments

LICENSE Outdated
@@ -1,6 +1,6 @@
MIT License

compas-dev
Copyright (c) 2023 COMPAS Association
Copy link
Member

Choose a reason for hiding this comment

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

haha just out of curiosity, are we expected to update this every year? what does this even mean?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I think we are. There are ever github actions for this: https://github.com/marketplace/actions/update-license-copyright-year-s

Copy link
Member Author

@gonzalocasas gonzalocasas Jan 7, 2024

Choose a reason for hiding this comment

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

I'm not entirely certain about the legal implications of claiming copyright every year, I guess it's related to the expiration of copyright. It seems the correct way is to do a year range (as I did now, ie 2023-2024, which I read as "we claim copyright on all years starting on 2023 and ending at 2024, and that needs to be updated yearly if we add changes)

requirements.txt Show resolved Hide resolved


class RobotModelArtist(BlenderArtist, RobotModelArtist):
"""Artist for drawing robot models in Blender.
class RobotModelObject(BlenderSceneObject, BaseRobotModelObject):
Copy link
Member

Choose a reason for hiding this comment

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

mmh RobotModelObject sounds a bit too generic to me RobotModelSceneObject too long/verbose?

Copy link
Member Author

Choose a reason for hiding this comment

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

I had it like that at first, but the convention in core seems to be XxxObject not XxxSceneObject (eg BoxObject, NetworkObject, etc)

src/compas_robots/configuration.py Show resolved Hide resolved
src/compas_robots/configuration.py Outdated Show resolved Hide resolved
src/compas_robots/model/geometry.py Outdated Show resolved Hide resolved
src/compas_robots/model/joint.py Outdated Show resolved Hide resolved
src/compas_robots/model/joint.py Outdated Show resolved Hide resolved
src/compas_robots/model/joint.py Outdated Show resolved Hide resolved
src/compas_robots/model/link.py Outdated Show resolved Hide resolved
Copy link
Member

@chenkasirer chenkasirer left a comment

Choose a reason for hiding this comment

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

LGTM!

@gonzalocasas gonzalocasas merged commit 382c4bc into main Jan 11, 2024
11 checks passed
@gonzalocasas gonzalocasas deleted the refactor_2.0 branch January 11, 2024 02:22
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