1. Sebastien Mondet
  2. sosa


Sebastien Mondet  committed d84046f

doc: add precisions to the README

  • Participants
  • Parent commits dcb51a2
  • Branches master

Comments (0)

Files changed (1)

File README.md

View file
  • Ignore whitespace
-This library is a set APIs defined with module types, and a set of
+This library is a set of APIs defined with module types, and a set of
 modules implementing one or more of those interfaces.
 The APIs define what a *character* and a *string of characters* should
 The functor `Of_mutable` uses an implementation of
+See the file `test/sosa_test.ml` for examples of usage (with `array`s of `UTF-8
+integers`, and `Bigarray.Array1.t` of bytes).
 ### Integer UTF-8 Characters
 OCaml integers (`int`) representing Utf8 characters (we force the
 handling of not more than 31 bits, even if [RFC 3629][RFC3629]
 restricts them to end at U+10FFFF, c.f. also
+[wikipedia][wikipedia:UTF-8]). Note that the function `is_whitespace` considers
+only ASCII whitespace (useful while writing parsers for example).
 Tests and Benchmarks