Skip to content

Commit e297190

Browse files
committed
Mention internal representation (UTF-16 vs UTF-8) in pkg desc
1 parent bacc17f commit e297190

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

text.cabal

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,25 @@ description:
2929
.
3030
> import qualified Data.Text as T
3131
.
32+
== ICU Support
33+
.
3234
To use an extended and very rich family of functions for working
3335
with Unicode text (including normalization, regular expressions,
3436
non-standard encodings, text breaking, and locales), see
3537
the [text-icu package](https://hackage.haskell.org/package/text-icu)
3638
based on the well-respected and liberally
3739
licensed [ICU library](http://site.icu-project.org/).
40+
.
41+
== Internal Representation: UTF-16 vs. UTF-8
42+
.
43+
Currently the @text@ library uses UTF-16 as its internal representation
44+
which is [neither a fixed-width nor always the most dense representation](http://utf8everywhere.org/)
45+
for Unicode text. We're currently investigating the feasibility
46+
of [changing Text's internal representation to UTF-8](https://github.com/text-utf8)
47+
and if you need such a 'Text' type right now you might be interested in using the spin-off
48+
packages <https://hackage.haskell.org/package/text-utf8 text-utf8> and
49+
<https://hackage.haskell.org/package/text-short text-short>.
50+
3851

3952
license: BSD2
4053
license-file: LICENSE

0 commit comments

Comments
 (0)