Conversation
There was a problem hiding this comment.
I never found the previous version of the readme enlightening (rather the opposite actually), so the new one is definitely not worse.
One thing I feel should be added, is that one currently needs to consult the rule engine source code in order to learn the precise structure of the arguments listed in the API overview.
It might also not harm to provide links to the Capture app as a working example in JavaScript:
https://github.com/dhis2/capture-app/blob/master/src/core_modules/capture-core/rules/RuleEngine/RuleEngine.ts
https://github.com/dhis2/capture-app/blob/master/src/core_modules/capture-core/rules/RuleEngine/helpers/InputBuilder.ts
| This library uses the [Binary Compatibility Validator plugin](https://github.com/Kotlin/binary-compatibility-validator), which verifies that there are no changes in the public API of the library. | ||
|
|
||
| The way of work is: there is a file generated by the plugin (`api/expression-parser.api`) with the binary representation of the expected public API. The plugin has a task (`apiCheck`) that verifies that the public API of the code matches the expected API in the file. | ||
| The way of work is: there is a file generated by the plugin (`api/rule-engine.api`) with the binary representation of the expected public API. The plugin has a task (`apiCheck`) that verifies that the public API of the code matches the expected API in the file. |
There was a problem hiding this comment.
Good idea to add this paragraph, but could use some restructuring to read better.
2 participants
Update README file