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 merge requests found
Checking pipeline status
...@@ -155,7 +155,8 @@ requests.post( ...@@ -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. and call the `step`, `get_json_state`, and `perform_action` methods directly.
```python ```python
...@@ -219,32 +220,31 @@ can be cooked/created. ...@@ -219,32 +220,31 @@ can be cooked/created.
For example For example
```yaml CuttingBoard:
CuttingBoard: type: Equipment
type: Equipment
Stove:
Stove: type: Equipment
type: Equipment
Pot:
Pot: type: Equipment
type: Equipment equipment: Stove
equipment: Stove
Tomato:
Tomato: type: Ingredient
type: Ingredient
ChoppedTomato:
ChoppedTomato: type: Ingredient
type: Ingredient needs: [ Tomato ]
needs: [ Tomato ] seconds: 4.0
seconds: 4.0 equipment: CuttingBoard
equipment: CuttingBoard
TomatoSoup:
TomatoSoup: type: Meal
type: Meal needs: [ ChoppedTomato, ChoppedTomato, ChoppedTomato ]
needs: [ ChoppedTomato, ChoppedTomato, ChoppedTomato ] seconds: 6.0
seconds: 6.0 equipment: Pot
equipment: Pot
```
## Layout Config ## Layout Config
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment