Add warnings to unsafe modules
commit77fef5f660cf65059f89069568f3955f4922bbbf
authorBryan O'Sullivan <bos@serpentine.com>
dateWed 4 Dec 2013, 16:11 (13 years ago)
parent717be11
Data/Text/Internal/Builder.hs+4
@@ -11,6 +11,10 @@
1111-- Stability : experimental
1212-- Portability : portable to Hugs and GHC
1313--
14+-- /Warning/: this is an internal module, and does not have a stable
15+-- API or name. Functions in this module may not check or enforce
16+-- preconditions expected by public modules. Use at your own risk!
17+--
1418-- Efficient construction of lazy @Text@ values. The principal
1519-- operations on a @Builder@ are @singleton@, @fromText@, and
1620-- @fromLazyText@, which construct new builders, and 'mappend', which
Data/Text/Internal/Builder/Functions.hs+4
@@ -9,6 +9,10 @@
99-- Stability : experimental
1010-- Portability : GHC
1111--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
1216-- Useful functions and combinators.
1317
1418module Data.Text.Internal.Builder.Functions
Data/Text/Internal/Builder/Int/Digits.hs+4
@@ -7,6 +7,10 @@
77-- Stability: experimental
88-- Portability: portable
99--
10+-- /Warning/: this is an internal module, and does not have a stable
11+-- API or name. Functions in this module may not check or enforce
12+-- preconditions expected by public modules. Use at your own risk!
13+--
1014-- This module exists because the C preprocessor does things that we
1115-- shall not speak of when confronted with Haskell multiline strings.
1216
Data/Text/Internal/Builder/RealFloat/Functions.hs+4
@@ -2,6 +2,10 @@
22-- Module: Data.Text.Internal.Builder.RealFloat.Functions
33-- Copyright: (c) The University of Glasgow 1994-2002
44-- License: see libraries/base/LICENSE
5+--
6+-- /Warning/: this is an internal module, and does not have a stable
7+-- API or name. Functions in this module may not check or enforce
8+-- preconditions expected by public modules. Use at your own risk!
59
610module Data.Text.Internal.Builder.RealFloat.Functions
711 (
Data/Text/Internal/Encoding/Fusion.hs+4
@@ -12,6 +12,10 @@
1212-- Stability : experimental
1313-- Portability : portable
1414--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
1519-- Fusible 'Stream'-oriented functions for converting between 'Text'
1620-- and several common encodings.
1721
Data/Text/Internal/Encoding/Fusion/Common.hs+3
@@ -13,6 +13,9 @@
1313-- Stability : experimental
1414-- Portability : portable
1515--
16+-- /Warning/: this is an internal module, and does not have a stable
17+-- API or name. Use at your own risk!
18+--
1619-- Fusible 'Stream'-oriented functions for converting between 'Text'
1720-- and several common encodings.
1821
Data/Text/Internal/Encoding/Utf16.hs+4
@@ -12,6 +12,10 @@
1212-- Stability : experimental
1313-- Portability : GHC
1414--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
1519-- Basic UTF-16 validation and character manipulation.
1620module Data.Text.Internal.Encoding.Utf16
1721 (
Data/Text/Internal/Encoding/Utf32.hs+4
@@ -10,6 +10,10 @@
1010-- Stability : experimental
1111-- Portability : portable
1212--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
1317-- Basic UTF-32 validation.
1418module Data.Text.Internal.Encoding.Utf32
1519 (
Data/Text/Internal/Encoding/Utf8.hs+4
@@ -12,6 +12,10 @@
1212-- Stability : experimental
1313-- Portability : GHC
1414--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
1519-- Basic UTF-8 validation and character manipulation.
1620module Data.Text.Internal.Encoding.Utf8
1721 (
Data/Text/Internal/Functions.hs+4
@@ -9,6 +9,10 @@
99-- Stability : experimental
1010-- Portability : GHC
1111--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
1216-- Useful functions.
1317
1418module Data.Text.Internal.Functions
Data/Text/Internal/Fusion.hs+4
@@ -12,6 +12,10 @@
1212-- Stability : experimental
1313-- Portability : GHC
1414--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
1519-- Text manipulation functions represented as fusible operations over
1620-- streams.
1721module Data.Text.Internal.Fusion
Data/Text/Internal/Fusion/Common.hs+4
@@ -9,6 +9,10 @@
99-- Stability : experimental
1010-- Portability : GHC
1111--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
1216-- Common stream fusion functionality for text.
1317
1418module Data.Text.Internal.Fusion.Common
Data/Text/Internal/Fusion/Size.hs+4
@@ -11,6 +11,10 @@
1111-- Stability : experimental
1212-- Portability : portable
1313--
14+-- /Warning/: this is an internal module, and does not have a stable
15+-- API or name. Functions in this module may not check or enforce
16+-- preconditions expected by public modules. Use at your own risk!
17+--
1418-- Size hints.
1519
1620module Data.Text.Internal.Fusion.Size
Data/Text/Internal/Fusion/Types.hs+4
@@ -12,6 +12,10 @@
1212-- Stability : experimental
1313-- Portability : GHC
1414--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
1519-- Core stream fusion functionality for text.
1620
1721module Data.Text.Internal.Fusion.Types
Data/Text/Internal/IO.hs+4
@@ -8,6 +8,10 @@
88-- Stability : experimental
99-- Portability : GHC
1010--
11+-- /Warning/: this is an internal module, and does not have a stable
12+-- API or name. Functions in this module may not check or enforce
13+-- preconditions expected by public modules. Use at your own risk!
14+--
1115-- Low-level support for text I\/O.
1216
1317module Data.Text.Internal.IO
Data/Text/Internal/Lazy.hs+4−4
@@ -9,13 +9,13 @@
99-- Stability : experimental
1010-- Portability : GHC
1111--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
1216-- A module containing private 'Text' internals. This exposes the
1317-- 'Text' representation and low level construction functions.
1418-- Modules which extend the 'Text' system may need to use this module.
15−--
16−-- You should not use this module unless you are determined to monkey
17−-- with the internals, as the functions here do just about nothing to
18−-- preserve data invariants. You have been warned!
1919
2020module Data.Text.Internal.Lazy
2121 (
Data/Text/Internal/Lazy/Encoding/Fusion.hs+4
@@ -10,6 +10,10 @@
1010-- Stability : experimental
1111-- Portability : portable
1212--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
1317-- Fusible 'Stream'-oriented functions for converting between lazy
1418-- 'Text' and several common encodings.
1519
Data/Text/Internal/Lazy/Fusion.hs+4
@@ -9,6 +9,10 @@
99-- Stability : experimental
1010-- Portability : GHC
1111--
12+-- /Warning/: this is an internal module, and does not have a stable
13+-- API or name. Functions in this module may not check or enforce
14+-- preconditions expected by public modules. Use at your own risk!
15+--
1216-- Core stream fusion functionality for text.
1317
1418module Data.Text.Internal.Lazy.Fusion
Data/Text/Internal/Lazy/Search.hs+4
@@ -10,6 +10,10 @@
1010-- Stability : experimental
1111-- Portability : GHC
1212--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
1317-- Fast substring search for lazy 'Text', based on work by Boyer,
1418-- Moore, Horspool, Sunday, and Lundh. Adapted from the strict
1519-- implementation.
Data/Text/Internal/Unsafe.hs+6−2
@@ -8,8 +8,12 @@
88-- Stability : experimental
99-- Portability : portable
1010--
11−-- A module containing unsafe operations, for very very careful use in
12−-- heavily tested code.
11+-- /Warning/: this is an internal module, and does not have a stable
12+-- API or name. Functions in this module may not check or enforce
13+-- preconditions expected by public modules. Use at your own risk!
14+--
15+-- A module containing /unsafe/ operations, for /very very careful/ use
16+-- in /heavily tested/ code.
1317module Data.Text.Internal.Unsafe
1418 (
1519 inlineInterleaveST
Data/Text/Internal/Unsafe/Char.hs+4
@@ -12,6 +12,10 @@
1212-- Stability : experimental
1313-- Portability : GHC
1414--
15+-- /Warning/: this is an internal module, and does not have a stable
16+-- API or name. Functions in this module may not check or enforce
17+-- preconditions expected by public modules. Use at your own risk!
18+--
1519-- Fast character manipulation functions.
1620module Data.Text.Internal.Unsafe.Char
1721 (
Data/Text/Internal/Unsafe/Shift.hs+4
@@ -10,6 +10,10 @@
1010-- Stability : experimental
1111-- Portability : GHC
1212--
13+-- /Warning/: this is an internal module, and does not have a stable
14+-- API or name. Functions in this module may not check or enforce
15+-- preconditions expected by public modules. Use at your own risk!
16+--
1317-- Fast, unchecked bit shifting functions.
1418
1519module Data.Text.Internal.Unsafe.Shift