[commit: bytestring] master: Fix docs that use old showF/showB testing functions (cdc10f8)
Ian Lynagh
igloo at earth.li
Sat Nov 17 14:58:05 CET 2012
Repository : ssh://darcs.haskell.org//srv/darcs/packages/bytestring
On branch : master
http://hackage.haskell.org/trac/ghc/changeset/cdc10f82046271976d86cb437dca771dc4010809
>---------------------------------------------------------------
commit cdc10f82046271976d86cb437dca771dc4010809
Author: Duncan Coutts <duncan at community.haskell.org>
Date: Thu Sep 20 08:35:59 2012 +0000
Fix docs that use old showF/showB testing functions
>---------------------------------------------------------------
Data/ByteString/Builder/Prim/ASCII.hs | 4 ++--
Data/ByteString/Builder/Prim/Internal.hs | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Data/ByteString/Builder/Prim/ASCII.hs b/Data/ByteString/Builder/Prim/ASCII.hs
index 6ef2148..32d418a 100644
--- a/Data/ByteString/Builder/Prim/ASCII.hs
+++ b/Data/ByteString/Builder/Prim/ASCII.hs
@@ -44,7 +44,7 @@ module Data.ByteString.Builder.Prim.ASCII
-- ASCII characters. The shortest possible representation is used. For
-- example,
--
- -- > showB word16Hex 0x0a10 = "a10"
+ -- > toLazyByteString (primBounded word16Hex 0x0a10) = "a10"
--
-- Note that there is no support for using upper-case characters. Please
-- contact the maintainer if your application cannot work without
@@ -61,7 +61,7 @@ module Data.ByteString.Builder.Prim.ASCII
-- | Encoding the bytes of fixed-width types as hexadecimal
-- numbers using lower-case ASCII characters. For example,
--
- -- > showF word16HexFixed 0x0a10 = "0a10"
+ -- > toLazyByteString (primFixed word16HexFixed 0x0a10) = "0a10"
--
, int8HexFixed
, int16HexFixed
diff --git a/Data/ByteString/Builder/Prim/Internal.hs b/Data/ByteString/Builder/Prim/Internal.hs
index 5375fd9..5bd2236 100644
--- a/Data/ByteString/Builder/Prim/Internal.hs
+++ b/Data/ByteString/Builder/Prim/Internal.hs
@@ -125,11 +125,11 @@ infixr 5 >*<
--
-- For example,
--
--- > showF (char7 >*< char7) ('x','y') = "xy"
+-- > toLazyByteString (primFixed (char7 >*< char7) ('x','y')) = "xy"
--
-- We can combine multiple primitives using '>*<' multiple times.
--
--- > showEncoding (char7 >*< char7 >*< char7) ('x',('y','z')) = "xyz"
+-- > toLazyByteString (primFixed (char7 >*< char7 >*< char7) ('x',('y','z'))) = "xyz"
--
(>*<) :: Monoidal f => f a -> f b -> f (a, b)
(>*<) = pair
More information about the Cvs-libraries
mailing list