Simmy API review Part 3 - Set enabled to true by default

[peter-csala]

Pull Request

The issue or feature being addressed

#1901

Details on the issue fix or feature implementation

• Changed the default value of Enabled from false to true
• Added clarifications about property precedence

Confirm the following

• I started this PR by branching from the head of the default branch
• I have targeted the PR to merge into the default branch
• I have included unit tests for the issue/feature
• I have successfully run a local build

[peter-csala]

@martintmk Shall I add the renaming of BehaviorAction to BehaviorGenerator to this PR or should I create a separate instead?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5897459) 84.80% compared to head (b557b5c) 84.79%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1916      +/-   ##
==========================================
- Coverage   84.80%   84.79%   -0.01%     
==========================================
  Files         312      312              
  Lines        6897     6893       -4     
  Branches     1056     1056              
==========================================
- Hits         5849     5845       -4     
  Misses        839      839              
  Partials      209      209              

Flag	Coverage Δ
linux	84.79% <100.00%> (?)
macos	84.79% <100.00%> (-0.01%)	⬇️
windows	84.79% <100.00%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[martincostello]

This is much terser and intuitive.

I wonder if we should put a note in the documentation somewhere that people should take care with the default being on, as if this is being used in production you'd be getting chaos as an opt-out rather than an opt-in as a change in behaviour to previous releases(?) of Simmy, so any configuration that might be tied to turning chaos on or not would be inverted.

[peter-csala]

I wonder if we should put a note in the documentation somewhere that people should take care with the default being on, as if this is being used in production you'd be getting chaos as an opt-out rather than an opt-in as a change in behaviour to previous releases(?) of Simmy, so any configuration that might be tied to turning chaos on or not would be inverted.

Done