Skip to content
Snippets Groups Projects
Commit f7f578b8 authored by Florian Schröder's avatar Florian Schröder
Browse files

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.
parent fa5595ea
No related branches found
No related tags found
No related merge requests found
Pipeline #45192 passed
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment