From 85351ce46b88f960225dedb9486bc34e3175f86e Mon Sep 17 00:00:00 2001 From: Preetham Gujjula Date: Tue, 7 May 2024 15:31:10 -0700 Subject: [PATCH] Add note about retaining multiple implementations --- package.yaml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/package.yaml b/package.yaml index 39eedb9..9d36408 100644 --- a/package.yaml +++ b/package.yaml @@ -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: