docs(python): Various deprecation docstring improvements (#15648)

Co-authored-by: Henry Harbeck <[email protected]> Co-authored-by: Alexander Beedie <[email protected]>
pola-rs · Apr 15, 2024 · 70b71da · 70b71da
1 parent 5e68541
commit 70b71da
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/py-polars/polars/__init__.py b/py-polars/polars/__init__.py
@@ -297,6 +297,7 @@
     "PolarsDataType",
     # polars.io
     "read_avro",
+    "read_clipboard",
     "read_csv",
     "read_csv_batched",
     "read_database",
@@ -318,7 +319,6 @@
     "scan_ndjson",
     "scan_parquet",
     "scan_pyarrow_dataset",
-    "read_clipboard",
     # polars.stringcache
     "StringCache",
     "disable_string_cache",

diff --git a/py-polars/polars/_utils/deprecation.py b/py-polars/polars/_utils/deprecation.py
@@ -80,7 +80,7 @@ def deprecate_parameter_as_positional(
     old_name: str, *, version: str
 ) -> Callable[[Callable[P, T]], Callable[P, T]]:
     """
-    Decorator to mark a function argument as deprecated due to being made positinoal.
+    Decorator to mark a function argument as deprecated due to being made positional.
 
     Use as follows::
 

diff --git a/py-polars/polars/dataframe/frame.py b/py-polars/polars/dataframe/frame.py
@@ -4796,7 +4796,7 @@ def with_row_count(self, name: str = "row_nr", offset: int = 0) -> Self:
         """
         Add a column at index 0 that counts the rows.
 
-        .. deprecated::
+        .. deprecated:: 0.20.4
             Use :meth:`with_row_index` instead.
             Note that the default column name has changed from 'row_nr' to 'index'.
 

diff --git a/py-polars/polars/expr/datetime.py b/py-polars/polars/expr/datetime.py
@@ -193,7 +193,7 @@ def truncate(
             - `False`: use the latest datetime
 
             .. deprecated:: 0.19.0
-                Use `ambiguous` instead
+                This is now automatically inferred; you can safely omit this argument.
         ambiguous
             Determine how to deal with ambiguous datetimes:
 

diff --git a/py-polars/polars/expr/string.py b/py-polars/polars/expr/string.py
@@ -2586,7 +2586,7 @@ def rjust(self, length: int, fill_char: str = " ") -> Expr:
         """
         return self.pad_start(length, fill_char)
 
-    @deprecate_renamed_function("json_decode", version="0.19.12")
+    @deprecate_renamed_function("json_decode", version="0.19.15")
     def json_extract(
         self,
         dtype: PolarsDataType | None = None,

diff --git a/py-polars/polars/io/__init__.py b/py-polars/polars/io/__init__.py
@@ -15,6 +15,7 @@
 
 __all__ = [
     "read_avro",
+    "read_clipboard",
     "read_csv",
     "read_csv_batched",
     "read_database",
@@ -36,5 +37,4 @@
     "scan_ndjson",
     "scan_parquet",
     "scan_pyarrow_dataset",
-    "read_clipboard",
 ]
diff --git a/py-polars/polars/lazyframe/frame.py b/py-polars/polars/lazyframe/frame.py
@@ -4712,7 +4712,7 @@ def with_row_count(self, name: str = "row_nr", offset: int = 0) -> Self:
         """
         Add a column at index 0 that counts the rows.
 
-        .. deprecated::
+        .. deprecated:: 0.20.4
             Use :meth:`with_row_index` instead.
             Note that the default column name has changed from 'row_nr' to 'index'.
 

diff --git a/py-polars/polars/series/datetime.py b/py-polars/polars/series/datetime.py
@@ -1694,7 +1694,7 @@ def truncate(
             - `False`: use the latest datetime
 
             .. deprecated:: 0.19.0
-                Use `ambiguous` instead
+                This is now automatically inferred; you can safely omit this argument.
         ambiguous
             Determine how to deal with ambiguous datetimes: