docs

inoas · Feb 28, 2024 · d03388b · d03388b
1 parent 25a3cf0
commit d03388b
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/glychee/configuration.gleam b/src/glychee/configuration.gleam
@@ -1,3 +1,8 @@
+//// Optional configuration of Benchee.
+////
+//// Configuration is stored in ETS.
+
+/// For details see [Benchee docs' configuration chapter](https://hexdocs.pm/benchee/Benchee.Configuration.html#t:user_configuration/0).
 pub type BencheeConfigurationKey {
   MemoryTime
   Parallel
@@ -6,12 +11,18 @@ pub type BencheeConfigurationKey {
   Warmup
 }
 
+/// Configuration values are all positive integers.
+///
 pub type BencheeConfigurationValue =
   Int
 
+/// Initialize the ETS configuration table.
+///
 @external(erlang, "Elixir.GlycheeBenchee", "initialize_configuration")
 pub fn initialize() -> Nil
 
+/// Set a config pair.
+///
 @external(erlang, "Elixir.GlycheeBenchee", "set_configuration_pair")
 pub fn set_pair(
   key configuration_key: BencheeConfigurationKey,