Add `@since 1.1.1.*` annotations
authorHerbert Valerio Riedel <hvr@gnu.org>
Sat, 23 Dec 2017 17:38:51 +0000 (18:38 +0100)
committerHerbert Valerio Riedel <hvr@gnu.org>
Sat, 23 Dec 2017 18:08:54 +0000 (19:08 +0100)
Also add note about when `Array`/`MArray` constructors were exposed
(c.f. 9ea72a0457f3269a50c7867752f9bb19a0cdd69c)

Data/Text.hs
Data/Text/Array.hs
Data/Text/Lazy.hs
Data/Text/Unsafe.hs

index 6a8a4b1..f35e976 100644 (file)
@@ -1120,6 +1120,8 @@ iterN n t@(Text _arr _off len) = loop 0 0
 -- Examples:
 --
 -- > takeEnd 3 "foobar" == "bar"
+--
+-- @since 1.1.1.0
 takeEnd :: Int -> Text -> Text
 takeEnd n t@(Text arr off len)
     | n <= 0    = empty
@@ -1159,6 +1161,8 @@ drop n t@(Text arr off len)
 -- Examples:
 --
 -- > dropEnd 3 "foobar" == "foo"
+--
+-- @since 1.1.1.0
 dropEnd :: Int -> Text -> Text
 dropEnd n t@(Text arr off len)
     | n <= 0    = t
index fee18c5..57527fb 100644 (file)
@@ -80,6 +80,8 @@ import GHC.Word (Word16(..))
 import Prelude hiding (length, read)
 
 -- | Immutable array type.
+--
+-- The 'Array' constructor is exposed since @text-1.1.1.3@
 data Array = Array {
       aBA :: ByteArray#
 #if defined(ASSERTS)
@@ -88,6 +90,8 @@ data Array = Array {
     }
 
 -- | Mutable array type, for use in the ST monad.
+--
+-- The 'MArray' constructor is exposed since @text-1.1.1.3@
 data MArray s = MArray {
       maBA :: MutableByteArray# s
 #if defined(ASSERTS)
index 4feff68..b83df61 100644 (file)
@@ -1073,6 +1073,8 @@ take i t0         = take' i t0
 -- Examples:
 --
 -- > takeEnd 3 "foobar" == "bar"
+--
+-- @since 1.1.1.0
 takeEnd :: Int64 -> Text -> Text
 takeEnd n t0
     | n <= 0    = empty
@@ -1111,6 +1113,8 @@ drop i t0
 -- Examples:
 --
 -- > dropEnd 3 "foobar" == "foo"
+--
+-- @since 1.1.1.0
 dropEnd :: Int64 -> Text -> Text
 dropEnd n t0
     | n <= 0    = t0
index 49a8560..3689977 100644 (file)
@@ -98,6 +98,8 @@ reverseIter (Text arr off _len) i
 -- | /O(1)/ Iterate one step backwards through a UTF-16 array,
 -- returning the delta to add (i.e. a negative number) to give the
 -- next offset to iterate at.
+--
+-- @since 1.1.1.0
 reverseIter_ :: Text -> Int -> Int
 reverseIter_ (Text arr off _len) i
     | m < 0xDC00 || m > 0xDFFF = -1