Add ‘since’ notes to relatively new functions
authormrkkrp <markkarpov@opmbx.org>
Thu, 3 Nov 2016 21:37:51 +0000 (00:37 +0300)
committermrkkrp <markkarpov@opmbx.org>
Thu, 3 Nov 2016 21:37:51 +0000 (00:37 +0300)
Data/ByteString.hs
Data/ByteString/Lazy.hs

index 743bc86..af4e889 100644 (file)
@@ -1273,6 +1273,8 @@ isPrefixOf (PS x1 s1 l1) (PS x2 s2 l2)
 -- | /O(n)/ The 'stripPrefix' function takes two ByteStrings and returns 'Just'
 -- the remainder of the second iff the first is its prefix, and otherwise
 -- 'Nothing'.
+--
+-- @since 0.10.8.0
 stripPrefix :: ByteString -> ByteString -> Maybe ByteString
 stripPrefix bs1@(PS _ _ l1) bs2
    | bs1 `isPrefixOf` bs2 = Just (unsafeDrop l1 bs2)
index 5b1cf5a..5b1d546 100644 (file)
@@ -890,7 +890,8 @@ elemIndex w cs0 = elemIndex' 0 cs0
 --
 -- > elemIndexEnd c xs ==
 -- > (-) (length xs - 1) `fmap` elemIndex c (reverse xs)
-
+--
+-- @since 0.10.6.0
 elemIndexEnd :: Word8 -> ByteString -> Maybe Int64
 elemIndexEnd w = elemIndexEnd' 0
   where
@@ -1037,6 +1038,8 @@ isPrefixOf (Chunk x xs) (Chunk y ys)
 -- | /O(n)/ The 'stripPrefix' function takes two ByteStrings and returns 'Just'
 -- the remainder of the second iff the first is its prefix, and otherwise
 -- 'Nothing'.
+--
+-- @since 0.10.8.0
 stripPrefix :: ByteString -> ByteString -> Maybe ByteString
 stripPrefix Empty bs  = Just bs
 stripPrefix _ Empty  = Nothing