The option can be used if an example has mainly been added as another test case, but is not suitable
as a user example. User examples should be easy to understand. They should clearly show where and
why a rule is applied and where not. Complex examples with rarely used language constructs or
pathological use cases which are indeed important to test but not helpful for understanding can be
hidden from the documentation with this option.
While browsing the rules documentation, I noticed **many** rules were both in the Default Rules and in the Opt In Rules section.
After looking into it, the docs of the `drop(while predicate: (Element) throws -> Bool` function states:
A closure that takes an element of the sequence as its argument and returns true if the element should be skipped or false if it should be included. **Once the predicate returns false it will not be called again.**
This caused the `defaultRuleDocumentations` array to contain almost all `ruleDocumentation`.
* Add Example wrapper in order to display test failures inline when running in Xcode.
* Stop using Swift 5.1-only features so we can compile on Xcode 10.2.
* Wrap strings in Example.
* Add Changelog entry.
* Wrap all examples in Example struct.
* Better and more complete capturing of line numbers.
* Fix broken test.
* Better test traceability.
* Address or disable linting warnings.
* Add documentation comments.
* Disable linter for a few cases.
* Limit mutability and add copy-and-mutate utility functions.
* Limit scope of mutability.
Danny Moesch
Natan Rolnik
Ethan Wong
Benny Wong
Paul Taykalo
Zev Eisenberg
JP Simard
