Commits

Bryan O'Sullivan  committed c46a636

Add warnings to unsafe modules

  • Participants
  • Parent commits 9275047

Comments (0)

Files changed (22)

File Data/Text/Internal/Builder.hs

 -- Stability   : experimental
 -- Portability : portable to Hugs and GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Efficient construction of lazy @Text@ values.  The principal
 -- operations on a @Builder@ are @singleton@, @fromText@, and
 -- @fromLazyText@, which construct new builders, and 'mappend', which

File Data/Text/Internal/Builder/Functions.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Useful functions and combinators.
 
 module Data.Text.Internal.Builder.Functions

File Data/Text/Internal/Builder/Int/Digits.hs

 -- Stability:   experimental
 -- Portability: portable
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- This module exists because the C preprocessor does things that we
 -- shall not speak of when confronted with Haskell multiline strings.
 

File Data/Text/Internal/Builder/RealFloat/Functions.hs

 -- Module:    Data.Text.Internal.Builder.RealFloat.Functions
 -- Copyright: (c) The University of Glasgow 1994-2002
 -- License:   see libraries/base/LICENSE
+--
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
 
 module Data.Text.Internal.Builder.RealFloat.Functions
     (

File Data/Text/Internal/Encoding/Fusion.hs

 -- Stability   : experimental
 -- Portability : portable
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Fusible 'Stream'-oriented functions for converting between 'Text'
 -- and several common encodings.
 

File Data/Text/Internal/Encoding/Fusion/Common.hs

 -- Stability   : experimental
 -- Portability : portable
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Use at your own risk!
+--
 -- Fusible 'Stream'-oriented functions for converting between 'Text'
 -- and several common encodings.
 

File Data/Text/Internal/Encoding/Utf16.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Basic UTF-16 validation and character manipulation.
 module Data.Text.Internal.Encoding.Utf16
     (

File Data/Text/Internal/Encoding/Utf32.hs

 -- Stability   : experimental
 -- Portability : portable
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Basic UTF-32 validation.
 module Data.Text.Internal.Encoding.Utf32
     (

File Data/Text/Internal/Encoding/Utf8.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Basic UTF-8 validation and character manipulation.
 module Data.Text.Internal.Encoding.Utf8
     (

File Data/Text/Internal/Functions.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Useful functions.
 
 module Data.Text.Internal.Functions

File Data/Text/Internal/Fusion.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Text manipulation functions represented as fusible operations over
 -- streams.
 module Data.Text.Internal.Fusion

File Data/Text/Internal/Fusion/Common.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Common stream fusion functionality for text.
 
 module Data.Text.Internal.Fusion.Common

File Data/Text/Internal/Fusion/Size.hs

 -- Stability   : experimental
 -- Portability : portable
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Size hints.
 
 module Data.Text.Internal.Fusion.Size

File Data/Text/Internal/Fusion/Types.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Core stream fusion functionality for text.
 
 module Data.Text.Internal.Fusion.Types

File Data/Text/Internal/IO.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Low-level support for text I\/O.
 
 module Data.Text.Internal.IO

File Data/Text/Internal/Lazy.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- A module containing private 'Text' internals. This exposes the
 -- 'Text' representation and low level construction functions.
 -- Modules which extend the 'Text' system may need to use this module.
---
--- You should not use this module unless you are determined to monkey
--- with the internals, as the functions here do just about nothing to
--- preserve data invariants.  You have been warned!
 
 module Data.Text.Internal.Lazy
     (

File Data/Text/Internal/Lazy/Encoding/Fusion.hs

 -- Stability   : experimental
 -- Portability : portable
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Fusible 'Stream'-oriented functions for converting between lazy
 -- 'Text' and several common encodings.
 

File Data/Text/Internal/Lazy/Fusion.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Core stream fusion functionality for text.
 
 module Data.Text.Internal.Lazy.Fusion

File Data/Text/Internal/Lazy/Search.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Fast substring search for lazy 'Text', based on work by Boyer,
 -- Moore, Horspool, Sunday, and Lundh.  Adapted from the strict
 -- implementation.

File Data/Text/Internal/Unsafe.hs

 -- Stability   : experimental
 -- Portability : portable
 --
--- A module containing unsafe operations, for very very careful use in
--- heavily tested code.
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
+-- A module containing /unsafe/ operations, for /very very careful/ use
+-- in /heavily tested/ code.
 module Data.Text.Internal.Unsafe
     (
       inlineInterleaveST

File Data/Text/Internal/Unsafe/Char.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Fast character manipulation functions.
 module Data.Text.Internal.Unsafe.Char
     (

File Data/Text/Internal/Unsafe/Shift.hs

 -- Stability   : experimental
 -- Portability : GHC
 --
+-- /Warning/: this is an internal module, and does not have a stable
+-- API or name. Functions in this module may not check or enforce
+-- preconditions expected by public modules. Use at your own risk!
+--
 -- Fast, unchecked bit shifting functions.
 
 module Data.Text.Internal.Unsafe.Shift