750443f · text · git.iko.soy

git.iko.soy/text

More haddock cleanups

commit750443f3d221fbdf571909b79fa948f208dd4407 authorHerbert Valerio Riedel <hvr@gnu.org> dateWed 27 Dec 2017, 14:39 (9 years ago) parent43fabc0

4 files changed+17−15

compare with master

unifiedsplit

Data/Text.hs+2−2 Data/Text/Encoding.hs+1−1 Data/Text/Lazy.hs+12−10 Data/Text/Lazy/Encoding.hs+2−2

Data/Text.hs+2−2

@@ -32,8 +32,8 @@

3232--

3333-- To use an extended and very rich family of functions for working

3434-- with Unicode text (including normalization, regular expressions,

35−-- non-standard encodings, text breaking, and locales), see

36−-- <http://hackage.haskell.org/package/text-icu the text-icu package >.

35+-- non-standard encodings, text breaking, and locales), see the

36+-- <http://hackage.haskell.org/package/text-icu text-icu package >.

3737--

3838

3939module Data.Text

Data/Text/Encoding.hs+1−1

@@ -18,7 +18,7 @@

1818-- using several standard encodings.

1919--

2020-- To gain access to a much larger family of encodings, use the

21−-- @text-icu@ package: <http://hackage.haskell.org/package/text-icu>

21+-- <http://hackage.haskell.org/package/text-icu text-icu package>.

2222

2323module Data.Text.Encoding

2424 (

Data/Text/Lazy.hs+12−10

@@ -274,14 +274,16 @@ import Text.Printf (PrintfArg, formatArg, formatString)

274274-- $replacement

275275--

276276-- A 'Text' value is a sequence of Unicode scalar values, as defined

277−-- in §3.9, definition D76 of the Unicode 5.2 standard:

278−-- <http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=35>. As

279−-- such, a 'Text' cannot contain values in the range U+D800 to U+DFFF

280−-- inclusive. Haskell implementations admit all Unicode code points

281−-- (§3.4, definition D10) as 'Char' values, including code points

282−-- from this invalid range. This means that there are some 'Char'

283−-- values that are not valid Unicode scalar values, and the functions

284−-- in this module must handle those cases.

277+-- in

278+-- <http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=35 §3.9, definition D76 of the Unicode 5.2 standard >.

279+-- As such, a 'Text' cannot contain values in the range U+D800 to

280+-- U+DFFF inclusive. Haskell implementations admit all Unicode code

281+-- points

282+-- (<http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=13 §3.4, definition D10 >)

283+-- as 'Char' values, including code points from this invalid range.

284+-- This means that there are some 'Char' values that are not valid

285+-- Unicode scalar values, and the functions in this module must handle

286+-- those cases.

285287--

286288-- Within this module, many functions construct a 'Text' from one or

287289-- more 'Char' values. Those functions will substitute 'Char' values

@@ -295,8 +297,8 @@ import Text.Printf (PrintfArg, formatArg, formatString)

295297-- range U+D800 through U+DFFF are used by UTF-16 to denote surrogate

296298-- code points, and so cannot be represented. The functions replace

297299-- invalid scalar values, instead of dropping them, as a security

298−-- measure. For details, see Unicode Technical Report 36, §3.5:

299−-- <http://unicode.org/reports/tr36#Deletion_of_Noncharacters>)

300+-- measure. For details, see

301+-- <http://unicode.org/reports/tr36/#Deletion_of_Noncharacters Unicode Technical Report 36, §3.5 >.)

300302

301303equal :: Text -> Text -> Bool

302304equal Empty Empty = True

Data/Text/Lazy/Encoding.hs+2−2

@@ -14,8 +14,8 @@

1414-- Functions for converting lazy 'Text' values to and from lazy

1515-- 'ByteString', using several standard encodings.

1616--

17−-- To gain access to a much larger variety of encodings, use the

18−-- @text-icu@ package: <http://hackage.haskell.org/package/text-icu>

17+-- To gain access to a much larger family of encodings, use the

18+-- <http://hackage.haskell.org/package/text-icu text-icu package>.

1919

2020module Data.Text.Lazy.Encoding

2121 (