Refactor text module doc

telekom · Dec 21, 2023 · b793692 · b793692
1 parent 47f630f
commit b793692
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/mltb2/text.py b/mltb2/text.py
@@ -2,7 +2,14 @@
 # This software is distributed under the terms of the MIT license
 # which is available at https://opensource.org/licenses/MIT
 
-"""Text specific module."""
+"""This module offers text specific tools.
+
+It offers the following functionality:
+
+- detect or clean invisible characters
+- detect or replace special whitespaces
+- remove duplicate whitespaces
+"""
 
 import re
 from typing import Dict, Final, Pattern, Tuple