From 00910c45cb0d57b49e70dd5a8331e00545d7b3eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
<fschroeder@techfak.uni-bielefeld.de>
Date: Wed, 3 Apr 2024 17:45:41 +0200
Subject: [PATCH] Update naming convention for Cooperative Cuisine
The term "CooperativeCuisine" in multiple files has been replaced with the correct name "Cooperative Cuisine". These changes are reflected in the main code documentation, pygame_2D visualization, item type enumeration, and the CHANGELOG.
---
CHANGELOG.md | 2 ++
cooperative_cuisine/__init__.py | 4 ++--
cooperative_cuisine/items.py | 2 +-
cooperative_cuisine/pygame_2d_vis/__init__.py | 4 ++--
4 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5de670e9..e4588eee 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,6 +15,8 @@
### Changed
+- `CooperativeCuisine` occurrences to `Cooperative Cuisine`
+
### Deprecated
### Removed
diff --git a/cooperative_cuisine/__init__.py b/cooperative_cuisine/__init__.py
index ae22c482..780a4f8b 100644
--- a/cooperative_cuisine/__init__.py
+++ b/cooperative_cuisine/__init__.py
@@ -1,6 +1,6 @@
"""
-This is the documentation of CooperativeCuisine.
+This is the documentation of Cooperative Cuisine.
# About the package
@@ -14,7 +14,7 @@ environments designed for reinforcement learning agents as well as the game and
players in a more "real-time"-like environment. They all mostly differ in the visual and graphics dimension. 2D
versions like [overcooked-ai](https://github.com/HumanCompatibleAI/overcooked_ai), [gym-cooking](
https://github.com/rosewang2008/gym-cooking) are most well-known in the community. Besides, the general
-adaptations of the original overcooked game. CooperativeCuisine, we want to bring both worlds together: the
+adaptations of the original overcooked game. Cooperative Cuisine, we want to bring both worlds together: the
reinforcement learning and real-time playable environment with an appealing visualisation. Enable the potential of
developing artificial agents that play with humans like a "real", cooperative, human partner.
diff --git a/cooperative_cuisine/items.py b/cooperative_cuisine/items.py
index 97167ec9..4bc2fa72 100644
--- a/cooperative_cuisine/items.py
+++ b/cooperative_cuisine/items.py
@@ -64,7 +64,7 @@ class EffectType(Enum):
class ItemType(Enum):
- """Enumeration of which types of items exists in *CooperativeCuisine*"""
+ """Enumeration of which types of items exists in *Cooperative Cuisine*"""
Ingredient = "Ingredient"
"""All ingredients and process ingredients."""
diff --git a/cooperative_cuisine/pygame_2d_vis/__init__.py b/cooperative_cuisine/pygame_2d_vis/__init__.py
index ed6999e4..71b0165f 100644
--- a/cooperative_cuisine/pygame_2d_vis/__init__.py
+++ b/cooperative_cuisine/pygame_2d_vis/__init__.py
@@ -1,8 +1,8 @@
"""
-2D visualization of the CooperativeCuisine.
+2D visualization of the Cooperative Cuisine.
You will play the levels accordingly to the study config:
-- You can play the CooperativeCuisine. You can quit the application in the top right or end the level in the bottom right
+- You can play the Cooperative Cuisine. You can quit the application in the top right or end the level in the bottom right
- The orders are pictured in the top, the current score in the bottom left and the remaining time in the bottom
- The final screen after ending a level shows the score
--
GitLab