It's pretty easy to forget to update the code examples in README.md when the API changes, which means the first usage example new users see might not even be correct. In order to catch such issues as quickly as possible, we should setup rust-skeptic. Doing so will ensure that code examples in the README will get tested as part of cargo test (and therefor as part of CI builds) just like any other doc test.
It's pretty easy to forget to update the code examples in
README.mdwhen the API changes, which means the first usage example new users see might not even be correct. In order to catch such issues as quickly as possible, we should setup rust-skeptic. Doing so will ensure that code examples in the README will get tested as part ofcargo test(and therefor as part of CI builds) just like any other doc test.