From ab26220b230b5f7b0eed6b5814ff8dad64174eb9 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Tue, 9 Oct 2018 10:43:03 -0700
Subject: [PATCH] lib: document SmartDate

[ci skip]
---
 hledger-lib/Hledger/Data/Types.hs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/hledger-lib/Hledger/Data/Types.hs b/hledger-lib/Hledger/Data/Types.hs
index ee24fcf52..4fee465a0 100644
--- a/hledger-lib/Hledger/Data/Types.hs
+++ b/hledger-lib/Hledger/Data/Types.hs
@@ -43,6 +43,9 @@ import Text.Printf
 import Hledger.Utils.Regex
 
 
+-- | A possibly incomplete date, whose missing parts will be filled from a reference date.
+-- A numeric year, month, and day of month, or the empty string for any of these.
+-- See the smartdate parser.
 type SmartDate = (String,String,String)
 
 data WhichDate = PrimaryDate | SecondaryDate deriving (Eq,Show)