minor docstring update and an extra unit test

pola-rs · Oct 11, 2023 · 1a7a485 · 1a7a485
1 parent fcc18d8
commit 1a7a485
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/py-polars/polars/config.py b/py-polars/polars/config.py
@@ -449,7 +449,8 @@ def set_float_precision(cls, precision: int | None = None) -> type[Config]:
         Parameters
         ----------
         precision : int
-            Number of decimal places to display
+            Number of decimal places to display; set to ``None`` to revert to the
+            default/standard behaviour.
 
         Notes
         -----

diff --git a/py-polars/tests/unit/test_cfg.py b/py-polars/tests/unit/test_cfg.py
@@ -571,6 +571,20 @@ def test_numeric_right_alignment() -> None:
             "│ 3.333000 ┆ 6.000000 ┆ 9.000000 │\n"
             "└──────────┴──────────┴──────────┘"
         )
+        with pl.Config(float_precision=None):
+            assert (
+                str(df) == "shape: (3, 3)\n"
+                "┌───────┬─────┬─────┐\n"
+                "│     a ┆   b ┆   c │\n"
+                "│   --- ┆ --- ┆ --- │\n"
+                "│   f64 ┆ f64 ┆ f64 │\n"
+                "╞═══════╪═════╪═════╡\n"
+                "│   1.1 ┆ 4.0 ┆ 7.0 │\n"
+                "│  2.22 ┆ 5.0 ┆ 8.0 │\n"
+                "│ 3.333 ┆ 6.0 ┆ 9.0 │\n"
+                "└───────┴─────┴─────┘"
+            )
+
     df = pl.DataFrame(
         {"a": [1.1, 22.2, 3.33], "b": [444, 55.5, 6.6], "c": [77.7, 8888, 9.9999]}
     )