eiffel-community / eiffel-intelligence

Eiffel Intelligence is a real time data aggregation and analysis solution for Eiffel events.
Apache License 2.0
11 stars 72 forks source link

Clarify rules documentation and remove unused fields in rules #397

Open e-pettersson-ericsson opened 4 years ago

e-pettersson-ericsson commented 4 years ago

Description

I've seen the field "ArrayMergeOptions" in our example rules files. However, there is no reference to this in either the documentation or use of it in the code, from what I could gather by quickly looking through it. If it is indeed not used, it should be removed from the example rules we provide. It should be investigated properly, and one of the following actions needs to be taken:

Motivation

1) To avoid unnecessary confusion. 2) To provide better documentation of use of rules

Exemplification

Benefits

Less complexity in the rules.

Possible Drawbacks

It shouldn't have any negative consequences if it is indeed not used anywhere, but this should be tested properly of course đŸ˜„

e-pettersson-ericsson commented 4 years ago

The same goes for the field "ProcessFunction" - there are no references to it in the code and it shouldn't remain in the example rules (or any test resources) since it only adds confusion.