RocketPy icon indicating copy to clipboard operation
RocketPy copied to clipboard

MNT: Name Conflict in `radius` property and input of `TankGeometry`

Open phmbressan opened this issue 1 year ago • 1 comments

Description of the Issue

The TankGeometry class has the input parameter radius which is not saved on its __init__ as it is part of the standard of other rocketpy classes and assumed by StochasticModels.

To complicate matters, the class has a property with the name radius which is a Function of the input parameter of the same name (i.e. the input parameter per se is not saved, but its Function is a property).

Some Possible Solution Paths

The following approaches may be considered:

  1. Changing the input parameter: differentiating the property and the input parameter by changing the latter name is possible while keeping breaking changes at minimum, I believe:

    • Input parameter radius could be changed to radius_function;
    • Allow for **kwargs and allow the key radius so as to keep compatibility.
  2. Changing the property's name: an alternative is to change the property's name. I find this solution harder to execute without breaking changes.

phmbressan avatar Dec 20 '24 17:12 phmbressan