From a8c85a85f6527938b804a9d111fe10f237806f7e Mon Sep 17 00:00:00 2001
From: Daniel Gröber <dxld@darkboxed.org>
Date: Sun, 16 Dec 2018 03:44:31 +0100
Subject: Reintroduce type conventions: s/proj_type/pt/ s/cache/c/

---
 lib/Distribution/Helper.hs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'lib/Distribution')

diff --git a/lib/Distribution/Helper.hs b/lib/Distribution/Helper.hs
index 73c3438..2f9493e 100644
--- a/lib/Distribution/Helper.hs
+++ b/lib/Distribution/Helper.hs
@@ -30,6 +30,9 @@ Portability : POSIX
 -}
 
 module Distribution.Helper (
+  -- * Type Variable Naming Conventions
+  -- $type-conventions
+
   -- * Running Queries
     Query
   , runQuery
@@ -143,6 +146,18 @@ import Distribution.Verbosity (silent, deafening)
 --import Distribution.Package (packageName, packageVersion)
 import Distribution.Simple.GHC as GHC (configure)
 
+-- $type-conventions
+-- Throughout the API we use the following conventions for type variables:
+--
+-- * @pt@ stands for "project type", when instantiated is always of kind
+--   'ProjType'.
+--
+-- * @c@ stands for "cache". It is used internally to make the cache
+--   inaccessible for some parts of the implementation. Users of the API may
+--   ignore it. See the internal 'qeCacheRef' field accessor of 'QueryEnv' for
+--   details.
+
+
 -- | A lazy, cached, query against a package's Cabal configuration. Use
 -- 'runQuery' to execute it.
 newtype Query pt a = Query
-- 
cgit v1.2.3