Skip to content

Unify spars and spars_merge documentation - #88

Merged
drametwally merged 1 commit into
mainfrom
unify-spars-candidate-generation-docs
Oct 1, 2026
Merged

drametwally merged 1 commit into
mainfrom
unify-spars-candidate-generation-docs

Conversation

@drametwally

@drametwally drametwally commented Oct 1, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • State in README and DESIGN that spars and spars_merge both apply to every inverted index type and every comparator, and differ only in key-major versus row-major traversal.
  • Remove README and DESIGN text that restricted spars_merge to specific comparators or inverted_term.
  • Align FilteredSearch, MergeSearch, and BaseSequenceComparator comments with the same scope.

Test plan

  • Docs-only change; no test run required
  • bazel test //:test_main (optional sanity)

README and DESIGN now describe both candidate generators as available on
every inverted index type with every comparator, differing only in traversal.
Align generator and sequence-comparator class comments with that wording.
@drametwally
drametwally merged commit 67c6a54 into main Oct 1, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant