[Snap Framework] Patch: 5f0d94e Snap-core: add warning message to internal interfaces we're exporting

noreply at snapframework.com noreply at snapframework.com
Mon Apr 12 23:46:10 CDT 2010


refname: refs/heads/master
commit 5f0d94e8777106730144516dea08f37678a403b5
Author: Gregory Collins <greg at gregorycollins.net>
Date:   Tue Apr 13 00:46:07 2010 -0400

    Snap-core: add warning message to internal interfaces we're exporting
---
 src/Snap/Internal/Debug.hs          |    7 +++++++
 src/Snap/Internal/Http/Types.hs     |    6 ++++++
 src/Snap/Internal/Iteratee/Debug.hs |    5 +++++
 3 files changed, 18 insertions(+), 0 deletions(-)

diff --git a/src/Snap/Internal/Debug.hs b/src/Snap/Internal/Debug.hs
index d868d53..64b3e5d 100644
--- a/src/Snap/Internal/Debug.hs
+++ b/src/Snap/Internal/Debug.hs
@@ -1,3 +1,10 @@
+-- | An internal Snap module for (optionally) printing debugging
+-- messages. Normally 'debug' does nothing, but you can hand-edit this file to
+-- cause debug messages to be sent to @stdout at .
+--
+-- /N.B./ this is an internal interface, please don't write external code that
+-- depends on it.
+
 module Snap.Internal.Debug where
 
 import           Control.Monad.Trans
diff --git a/src/Snap/Internal/Http/Types.hs b/src/Snap/Internal/Http/Types.hs
index 0a2ca53..b5f5dc0 100644
--- a/src/Snap/Internal/Http/Types.hs
+++ b/src/Snap/Internal/Http/Types.hs
@@ -1,3 +1,9 @@
+-- | An internal Snap module containing HTTP types.
+--
+-- /N.B./ this is an internal interface, please don't write user code that
+-- depends on it. Most of these declarations (except for the
+-- unsafe/encapsulation-breaking ones) are re-exported from "Snap.Types".
+
 {-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE EmptyDataDecls #-}
 {-# LANGUAGE OverloadedStrings #-}
diff --git a/src/Snap/Internal/Iteratee/Debug.hs b/src/Snap/Internal/Iteratee/Debug.hs
index 3bd9435..d08fe40 100644
--- a/src/Snap/Internal/Iteratee/Debug.hs
+++ b/src/Snap/Internal/Iteratee/Debug.hs
@@ -1,3 +1,8 @@
+-- | An internal Snap module for debugging iteratees.
+--
+-- /N.B./ this is an internal interface, please don't write user code that
+-- depends on it.
+
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 {-# LANGUAGE FlexibleInstances #-}
 


More information about the Snap mailing list