X-Git-Url: https://git.korewanetadesu.com/?p=python-collate.git;a=blobdiff_plain;f=collate%2F__init__.py;h=5094071fc4f8cdcd274986e0be1ed609ac1ceabf;hp=52d9e03de1b7a78cbfb4ae772a965a282e77ba00;hb=e8b221311bf60883d3f14083bab63fd947d34509;hpb=b30fef1f66891b5324e21e0f63f320df8c9880f2

diff --git a/collate/__init__.py b/collate/__init__.py
index 52d9e03..5094071 100644
--- a/collate/__init__.py
+++ b/collate/__init__.py
@@ -11,6 +11,12 @@ If available, this module uses the ICU localization library.
 Otherwise, it uses the system's locale database (and produces
 significantly worse results).
 
+This module tries very hard not to fail loudly. It tends to ignore
+most Unicode recoding errors, and will eventually fall back to the C
+locale or raw codepoint-based collation. If you would like loud
+failure, you can use the collate.strings module and the individual
+Collators directly.
+
 Trivial Use:
 ------------
 strings = read_strings(...)