From 3aa6170d818c58dd0e5b65c8c4c7fca5a3577150 Mon Sep 17 00:00:00 2001
From: Marco Gorelli <33491632+MarcoGorelli@users.noreply.github.com>
Date: Mon, 12 Aug 2024 16:07:17 +0100
Subject: [PATCH] minor updates

---
 docs/life_pt1.md | 26 ++++++++++++++++++--------
 docs/life_pt2.md | 10 +++++-----
 2 files changed, 23 insertions(+), 13 deletions(-)

diff --git a/docs/life_pt1.md b/docs/life_pt1.md
index 72a45d8..5b9de0a 100644
--- a/docs/life_pt1.md
+++ b/docs/life_pt1.md
@@ -5,7 +5,10 @@
 
 <hr>
 
-> ⚠️ __Note:__ This section is completely optional, and is provided for a bit of nerdy fun. It is by no means essential, feel free to skip it if it doesn't interest you!
+!!!note 
+    This section is completely optional, and is provided for a bit
+    of nerdy fun. It is by no means essential, feel free to skip
+    it if it doesn't interest you!
 
 Well, someone can, probably. But doom in a dataframe would be kinda hard to play, so let's try something simpler.
 [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) is a notorious Cellular Automaton that we could perhaps implement with a plugin.
@@ -16,7 +19,11 @@ For science, of course.
 Jokes aside, life allows us to show how a plugin can access elements in both neighbouring rows and columns for each element.
 With a little bit of extra Python, we can display things in an almost pretty manner.
 
-> __Note:__ For this tutorial, we'll assume you created a new plugin from the cookiecutter template and named it `game_of_life` (these steps aren't shown here, since they were already covered at the very beginning of this series).
+!!!note
+    For this tutorial, we'll assume you created a new plugin from the
+    cookiecutter template and named it `game_of_life`
+    (these steps aren't shown here, since they were already covered at the
+    very beginning of this series).
 
 In this section we'll cover the developer side of the plugin (both Python and Rust).
 In the next section we'll show how a user can import and use what we developed here.
@@ -62,11 +69,13 @@ Starting with the function to parse a board from a file or stdin:
 
 ```python
 def parse_board(
-        ifile: str
-               | bytes
-               | PathLike[str]
-               | PathLike[bytes]
-               | Iterable[str | bytes | PathLike[str] | PathLike[bytes]],
+    ifile: (
+        str
+        | bytes
+        | PathLike[str]
+        | PathLike[bytes]
+        | Iterable[str | bytes | PathLike[str] | PathLike[bytes]]
+    ),
 ) -> list[list[int]]:
     """
     Converts a board in a file containing only 0s and 1s, e.g.::
@@ -141,7 +150,8 @@ def board_to_df(board: list[list[int]]) -> pl.DataFrame:
 
 Let's skip `_nwise_wrapping` and `step` for now and jump straight to the last function - we'll return to the two we skipped soon:
 
-> Don't forget to read the comments!
+!!!note
+    Don't forget to read the comments!
 
 ```python
 def life_step(left: IntoExpr, mid: IntoExpr, right: IntoExpr) -> pl.Expr:
diff --git a/docs/life_pt2.md b/docs/life_pt2.md
index 9a863f8..38c033b 100644
--- a/docs/life_pt2.md
+++ b/docs/life_pt2.md
@@ -93,10 +93,10 @@ class Application:
     # ...
 
     def start(
-            self,
-            n: int | None = None,
-            delay: float | None = None,
-            print_df: bool = True,
+        self,
+        n: int | None = None,
+        delay: float | None = None,
+        print_df: bool = True,
     ):
         if n is None:
             n = self.steps
@@ -163,4 +163,4 @@ __Victory!__
 
 ## Reference
 
-The entire code for this plugin, including the user's side can be found on [GitHub](https://github.com/condekind/life_polars_plugin).
+The entire code for this plugin, including the user's side, can be found on [GitHub](https://github.com/condekind/life_polars_plugin).