update docs wip

Author: EgeKaraismailogluQC

diffly/summary.py

@@ -106,6 +106,7 @@ def format(self, pretty: bool | None = None) -> str:
             pretty: Whether to color the summary for the currently terminal window.
                 If set to `None`, will infer from the context.
         """
+        # REVIEW: I had to set force_jupyter=False here to avoid multiple output cells
         if pretty or pretty is None:
             console = Console(force_terminal=pretty, force_jupyter=False, width=WIDTH)
             with console.capture() as capture:

docs/guides/quickstart.ipynb

@@ -29,7 +29,7 @@
       "source": [
         "## Basic Comparison\n",
         "\n",
-        "To get started with diffly, you'll use the {func}`~diffly.compare_frames` function to compare two Polars DataFrames:"
+        "To get started with `diffly`, you'll use the {func}`~diffly.compare_frames` function to compare two Polars DataFrames:"
       ]
     },
     {
@@ -289,12 +289,12 @@
       "source": [
         "## Configuring Tolerances\n",
         "\n",
-        "When comparing floating point numbers or temporal data, exact equality may not be appropriate. diffly supports tolerance-based comparisons:"
+        "When comparing floating point numbers or temporal data, exact equality may not be appropriate. `diffly` supports tolerance-based comparisons:"
       ]
     },
     {
       "cell_type": "code",
-      "execution_count": 5,
+      "execution_count": null,
       "metadata": {},
       "outputs": [
         {
@@ -390,6 +390,8 @@
         }
       ],
       "source": [
+        "# REVIEW: In this example, do we have to supply the default value as 1e-08/1e-05? I thought there was a way to only pass a Mapping without needing to specify a default value.\n",
+        "\n",
         "from collections import defaultdict\n",
         "\n",
         "comparison_per_column = compare_frames(\n",
@@ -460,7 +462,7 @@
       "source": [
         "## Comparing LazyFrames\n",
         "\n",
-        "diffly works seamlessly with both {class}`polars.DataFrame` and {class}`polars.LazyFrame`:"
+        "`diffly` works seamlessly with both {class}`polars.DataFrame` and {class}`polars.LazyFrame`:"
       ]
     },
     {
@@ -574,7 +576,7 @@
       "source": [
         "## Using diffly in Tests\n",
         "\n",
-        "diffly provides assertion functions for use in test suites:"
+        "`diffly` provides assertion functions for use in test suites:"
       ]
     },
     {