Updated "translate_string" function docstring
authorThierry Florac <thierry.florac@onf.fr>
Mon, 18 Jan 2016 18:47:43 +0100 (2016-01-18)
changeset 54 044faae3d7ed
parent 53 13a3c247b295
child 55 d20591346980
Updated "translate_string" function docstring
src/pyams_utils/unicode.py
--- a/src/pyams_utils/unicode.py	Wed Oct 07 17:50:33 2015 +0200
+++ b/src/pyams_utils/unicode.py	Mon Jan 18 18:47:43 2016 +0100
@@ -82,13 +82,12 @@
     """Remove extended characters from string and replace them with 'basic' ones
     
     @param s: text to be cleaned.
-    @type s: str or unicode
     @param escape_slashes: if True, slashes are also converted
-    @type escape_slashes: boolean
     @param force_lower: if True, result is automatically converted to lower case
-    @type force_lower: boolean
+    @param spaces: character used to replace spaces
+    @param remove_punctuation: if True, all punctuation characters are removed
+    @param keep_chars: punctuation characters which may be kept
     @return: text without diacritics
-    @rtype: unicode
     """
     if escape_slashes:
         s = s.replace("\\", "/").split("/")[-1]