From b8df907e76b8ac7cdf59b26f0e75a477d926f122 Mon Sep 17 00:00:00 2001
From: stuebinm
Date: Sun, 21 Jul 2024 17:55:36 +0200
Subject: document publicly exposed interface

this documents most functions that might be used by downstream consumers
of this library, except for those in Conftrack.Pretty, which aren't done
yet.
---
 src/Conftrack/Source/Yaml.hs | 1 +
 1 file changed, 1 insertion(+)

(limited to 'src/Conftrack/Source/Yaml.hs')

diff --git a/src/Conftrack/Source/Yaml.hs b/src/Conftrack/Source/Yaml.hs
index 6adc798..4642922 100644
--- a/src/Conftrack/Source/Yaml.hs
+++ b/src/Conftrack/Source/Yaml.hs
@@ -6,6 +6,7 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE UndecidableInstances #-}
 
+-- | Functions for producing sources reading from yaml strings or files, using the aeson library.
 module Conftrack.Source.Yaml (YamlSource(..), mkYamlSource, mkYamlSourceWith, mkYamlFileSource) where
 
 import Conftrack.Source (SomeSource(..), ConfigSource (..))
-- 
cgit v1.2.3