From cb023f89713901d9575ed2381686cc1c2db9af8b Mon Sep 17 00:00:00 2001 From: etiennebacher Date: Sat, 28 Dec 2024 10:12:21 +0100 Subject: [PATCH] better docs --- py-polars/polars/expr/string.py | 9 ++++++++- py-polars/polars/series/string.py | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/py-polars/polars/expr/string.py b/py-polars/polars/expr/string.py index 8653e775aa3d..edecb8991aa2 100644 --- 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: . + + 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 index ae80915ad8be..be8e6064abce 100644 --- 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: . + + Parameters + ---------- + form : {'NFC', 'NFKC', 'NFD', 'NFKD'} + Unicode form to use. Examples --------