Skip to content

Commit

Permalink
Add note about retaining multiple implementations
Browse files Browse the repository at this point in the history
  • Loading branch information
pgujjula committed May 7, 2024
1 parent b3a6f31 commit 85351ce
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ library:
- containers ^>= {0.6}
- pqueue ^>= {1.4, 1.5}

# The library implements apply-merge in a few different ways, with slightly
# different performance characteristics, but only exports the current best
# implementation. But we wish to retain all the implementations, in case
# we are able to optimize a different implementation in the future to be better
# than the current best.
#
# So, we structure the test and benchmark suites to cover all the
# implementations, not just the one exposed by the library. To do this, the test
# and benchmark suites don't import the library, and instead directly include
# the src/ files.
tests:
apply-merge-tests:
source-dirs:
Expand Down

0 comments on commit 85351ce

Please sign in to comment.