Skip to content

docs: uneven and one inaccurate compat test description in TEST_COVERAGE.md #331

Closed

Description

@adityamukho

Summary

In docs/TEST_COVERAGE.md, the XTDB and Datomic compatibility sections' bullet descriptions drifted from the tests they describe.

Status

Partly fixed already. The kernel-locking branch regenerated both lists from the real function names, so every bullet now corresponds to a real test and every real test has a bullet, in both directions, for both files. What remains is quality, not correctness:

  • The nine pre-existing Datomic bullets are accurate but noticeably terser than the newly written ones. datomic_named_rule_reuse's description, for instance, mentions neither the three-node cycle nor the >= 3 assertion.
  • xtdb_entity_reference_join's description says "entities sharing a reference-valued attribute", but the test uses a bare keyword (:dept :dept-eng), not a Value::Ref(Uuid). The imprecision is inherited from the test's own source comment, which frames it as "find entities related through a reference".

Task

  • Bring the nine older Datomic descriptions up to the depth of the newer ones
  • Correct xtdb_entity_reference_join's description, and consider correcting the comment in tests/xtdb_compat_test.rs it derives from

Cosmetic. Filed so it is not lost.

Activity

  1. added a commit that references this issue on Aug 23, 2026
    4806119
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions