Add docs to example format selection writer

[jonnyandrew]

Changes

• Add documentation to example format selection writer (used in tests)
• Improve naming within selection writer code

Context

This part of the code base has caused some confusion for a maintainers including myself and could do with refactoring. As a stop-gap I've clarified some of the naming and added documentation.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[codecov-commenter]

Codecov Report

Patch coverage: 100.00% and project coverage change: +1.62 🎉

Comparison is base (9d6b58c) 88.12% compared to head (2c222b0) 89.74%.

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #701      +/-   ##
============================================
+ Coverage     88.12%   89.74%   +1.62%     
============================================
  Files           143       78      -65     
  Lines         16291    13590    -2701     
  Branches        762        0     -762     
============================================
- Hits          14356    12197    -2159     
+ Misses         1753     1393     -360     
+ Partials        182        0     -182     

Flag	Coverage Δ
uitests	?
uitests-android	?
uitests-ios	?
unittests	89.74% <100.00%> (+2.07%)	⬆️
unittests-android	?
unittests-ios	?
unittests-rust	89.74% <100.00%> (ø)

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

Impacted Files	Coverage Δ
...rates/wysiwyg/src/composer_model/example_format.rs	97.59% <100.00%> (ø)

... and 65 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[artcodespace]

Looks good to me, could have used this yesterday afternoon!

[artcodespace]

Hang on a minute - code cov is showing an improvement. Something fishy there.

[jonnyandrew]

Hang on a minute - code cov is showing an improvement. Something fishy there.

@alunturner I suspect it's something related to the fact that Android and iOS tests are not running here but they are on the main branch. I have created an issue:

• Code coverage change is not accurate on PRs #703