eiffel-community / eiffel-community/eiffel-intelligence

Clarify rules documentation and remove unused fields in rules

Open
#397 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
12
Forks
78
PR merge metrics
No merged PRs in 30d

Description

### 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:

* Remove unused field "ArrayMergeOptions" in rules to avoid confusion for everyone
* Or, if it turns out it is being used somewhere, it needs to be properly documented. And some example use cases should be provided in our test cases.
* Remove unused ProcessRules
* MergeResolverRules does NOT apply for start events but this is not documented anywhere.

### 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 😄

Contributor guide

Open the contributing guide

Research direction

Inspect the example rules, rule-processing code, documentation, and existing tests to determine whether ArrayMergeOptions and ProcessRules are used and how MergeResolverRules behaves for start events. Done means removing fields that are unused, or documenting supported fields with example test cases, and documenting the start-event limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.