From 42792f0b6d2e3f16d90c8bb930aa9d8fb81721fa Mon Sep 17 00:00:00 2001 From: Nicolas Biri Date: Thu, 9 Mar 2023 12:52:31 +0100 Subject: [PATCH] Document --- marconi-core/src/Marconi/Core/Experiment.hs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/marconi-core/src/Marconi/Core/Experiment.hs b/marconi-core/src/Marconi/Core/Experiment.hs index 9776504a9c..0bedc397cf 100644 --- a/marconi-core/src/Marconi/Core/Experiment.hs +++ b/marconi-core/src/Marconi/Core/Experiment.hs @@ -27,6 +27,12 @@ What's include in this module: - A full in-memory indexer (naive), an indexer that compose it with a SQL layer for persistence - A coordinator for indexers, that can be exposed as an itdexer itself + + In this module @desc@ is the descriptor of an indexer, + it's usually an uninhabited type used to define the corresponding type families. + The idea behind @desc@ is that you may want to provide different indexer for the same descriptor, + or to provide an indexer implementation that works for different descriptors. + -} module Marconi.Core.Experiment where