Safe-DS/API-Editor

Create a `Differ` abstract base class

lars-reimann opened this issue ยท 2 comments

Is your feature request related to a problem?

We need to define an interface for diff algorithms that match old API elements to new API elements.

Desired solution

Create an abstract base class with an @abstractmethod that describes the diff functionality. Particularly think about its inputs and outputs.

Maybe have separate functions to match classes, attributes, functions, parameters, etc.

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response

We could also break this down one step further and describe an interface to compute the similarity between two different API elements. It can then return some numeric value and the differ only needs to decide whether the similarity is high enough to consider the two API elements as matching.

๐ŸŽ‰ This issue has been resolved in version 1.69.0 ๐ŸŽ‰

The release is available on GitHub release

Your semantic-release bot ๐Ÿ“ฆ๐Ÿš€