d-led / gen_server_virtual_time / 048726894864b3852cd4d1d3b89be1d6e1709f6e-PR-2

88%

main: 88%

Pull #2

github

docs: make the documentation true again

An audit of every README against the code found claims that could not be
executed or were contradicted elsewhere in the same file:

* README used ActorSimulation.wrap_mermaid_html/1, which does not exist, and a
  get_state/1 helper that was never defined; both snippets now call the real API
* the state machine example (and the moduledoc it came from) used
  GenStateMachine, a package this library does not depend on
* the two speed-up tables contradicted each other by 36x, and neither matched
  benchmarks/README.md; there is now one measured table, reproduced by
  benchmarks/virtual_time_speedup.exs
* the flowchart shape and colour tables described shapes and colours the
  generator does not emit
* docs/generators.md installed "~> 0.2.0", a version that predates the
  generators it demonstrates
* the CAF test binary, OMNeT++ and Ractor versions, the test count, and the
  scripts README's description of its own workflow were all stale

The benchmarks README was quoting numbers from before an optimisation and
explaining a bottleneck that no longer exists; it now carries current
measurements. docs/index.md is published on HexDocs and links only to pages that
exist there, and the historical status page is marked as such.

162 of 246 new or added lines in 12 files covered. (65.85%)

2234 of 2633 relevant lines covered (84.85%)

4276.72 hits per line