epfl-lasa / control-libraries

A collection of library modules to facilitate the creation of full control loop algorithms, including state representation, motion planning, kinematics, dynamics and control.
https://epfl-lasa.github.io/control-libraries
GNU General Public License v3.0
27 stars 2 forks source link

Refactor frame_name parameters #309

Closed eeberhard closed 2 years ago

eeberhard commented 2 years ago

To make nomenclature more consistent (see also https://github.com/epfl-lasa/modulo/pull/123), all frame_name parameters and attributes have been renamed to frame. This PR also address #308 and makes the argument names in the python bindings match the nomenclature in the C++ class.

domire8 commented 2 years ago

this is potentially a breaking change no?

eeberhard commented 2 years ago

this is potentially a breaking change no?

Potentially, yes, though as mentioned in #308, it should be rare for someone to explicitly use keyword arguments for positional arguments in their Python. The ABI technically is unchanged.

This is not an urgent PR so we can also let it be until the next major release.

domire8 commented 2 years ago

Potentially, yes, though as mentioned in #308, it should be rare for someone to explicitly use keyword arguments for positional arguments in their Python.

I agree yes, it's very unlikely.

buschbapti commented 2 years ago

We shouldn't wait for that I would say.

domire8 commented 2 years ago

Should I finish this PR?

eeberhard commented 2 years ago

Should I finish this PR?

I think we can go ahead with the changes here since I found another potential breaking change in another feature I want to implement. I think it's just the changelog and such so I will update those