Skip to content

v0.63.0

Compare
Choose a tag to compare
@andywhite37 andywhite37 released this 05 May 03:47

Documentation and code coverage updates

This is a documentation/tooling update release - no API changes.

Documentation

Updated docs home page: https://reazen.github.io/relude/#/
Generated docs page: https://reazen.github.io/relude/api/index.html

  • @mlms13 undertook the monumental and soul-crushing effort to generate docs using odoc/bsdoc
    • All of the hand-written markdown docs were moved into code comments, and all the mostly empty markdown files were finally deleted
    • New documentation sidebar has a link to the generated API docs odoc entry point
  • The direction moving forward will be to put all API-related docs in code comments, and to potentially create a new hand-written "Recipes" section in the Docsify docs/ site.
    • The Recipes should cover common usage scenarios and patterns

Coverage

Updated Coverage (in Coveralls): https://coveralls.io/github/reazen/relude

  • @jihchi and @aantron figured out how to get bisect_ppx working well with BuckleScript and undertook the task of switching from Jest coverage to proper OCaml/Reason-based coverage.
    • It might have been a thankless task, but thank you for your efforts - they are greatly appreciated!
    • Tests are still run via Jest, but coverage data is collected against the reason code, which gives much more accurate coverage info
    • The Coveralls reporting is now actually useful in that we can upload coverage info at the file level for online browsing