From f7f578b8115951508dc6e9d33a04f4582ce17ee3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
 <fschroeder@techfak.uni-bielefeld.de>
Date: Wed, 31 Jan 2024 20:16:19 +0100
Subject: [PATCH] Improve readability of `__init__.py` documentation

This commit improves the readability of project documentation in `overcooked_simulator/__init__.py` file. Specifically, it separates the text about direct integration into separate lines for clarity and tidies up the example YAML configuration, consistently indenting the different sections of the content.
---
 overcooked_simulator/__init__.py | 54 ++++++++++++++++----------------
 1 file changed, 27 insertions(+), 27 deletions(-)

diff --git a/overcooked_simulator/__init__.py b/overcooked_simulator/__init__.py
index 14f91139..6bf7bbc4 100644
--- a/overcooked_simulator/__init__.py
+++ b/overcooked_simulator/__init__.py
@@ -155,7 +155,8 @@ requests.post(
 )
 ```
 
-## Direct integration into your code. You can use the `overcooked_simulator.overcooked_environment.Environment` class
+## Direct integration into your code.
+You can use the `overcooked_simulator.overcooked_environment.Environment` class
 and call the `step`, `get_json_state`, and `perform_action` methods directly.
 
 ```python
@@ -219,32 +220,31 @@ can be cooked/created.
 
 For example
 
-```yaml
-CuttingBoard:
-  type: Equipment
-
-Stove:
-  type: Equipment
-
-Pot:
-  type: Equipment
-  equipment: Stove
-
-Tomato:
-  type: Ingredient
-
-ChoppedTomato:
-  type: Ingredient
-  needs: [ Tomato ]
-  seconds: 4.0
-  equipment: CuttingBoard
-
-TomatoSoup:
-  type: Meal
-  needs: [ ChoppedTomato, ChoppedTomato, ChoppedTomato ]
-  seconds: 6.0
-  equipment: Pot
-```
+    CuttingBoard:
+      type: Equipment
+
+    Stove:
+      type: Equipment
+
+    Pot:
+      type: Equipment
+      equipment: Stove
+
+    Tomato:
+      type: Ingredient
+
+    ChoppedTomato:
+      type: Ingredient
+      needs: [ Tomato ]
+      seconds: 4.0
+      equipment: CuttingBoard
+
+    TomatoSoup:
+      type: Meal
+      needs: [ ChoppedTomato, ChoppedTomato, ChoppedTomato ]
+      seconds: 6.0
+      equipment: Pot
+
 
 ## Layout Config
 
-- 
GitLab