More release preparation. Docstrings and consistency work.

[python-collate.git] / collate / __init__.py

diff --git a/collate/__init__.py b/collate/__init__.py
index 52d9e03..5094071 100644 (file)
--- 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(...)