better docs

pola-rs · Dec 28, 2024 · cb023f8 · cb023f8
1 parent 18e903c
commit cb023f8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/py-polars/polars/expr/string.py b/py-polars/polars/expr/string.py
@@ -2934,7 +2934,14 @@ def escape_regex(self) -> Expr:
 
     def normalize(self, form: UnicodeForm = "NFC") -> Expr:
         """
-        Return the Unicode normal form for the strings in the Series/Index.
+        Returns the Unicode normal form of the string values.
+
+        This uses the forms described in Unicode Standard Annex 15: <https://www.unicode.org/reports/tr15/>.
+
+        Parameters
+        ----------
+        form : {'NFC', 'NFKC', 'NFD', 'NFKD'}
+            Unicode form to use.
 
         Examples
         --------

diff --git a/py-polars/polars/series/string.py b/py-polars/polars/series/string.py
@@ -2227,7 +2227,14 @@ def escape_regex(self) -> Series:
 
     def normalize(self, form: UnicodeForm = "NFC") -> Series:
         """
-        Return the Unicode normal form for the strings in the Series/Index.
+        Returns the Unicode normal form of the string values.
+
+        This uses the forms described in Unicode Standard Annex 15: <https://www.unicode.org/reports/tr15/>.
+
+        Parameters
+        ----------
+        form : {'NFC', 'NFKC', 'NFD', 'NFKD'}
+            Unicode form to use.
 
         Examples
         --------