From 9068e1d1b123a6eda9b7e456ade5bbe4e35fa8e2 Mon Sep 17 00:00:00 2001
From: "Andreas Koepf (aider)" <andreas.koepf@provisio.com>
Date: Thu, 20 Feb 2025 22:39:22 +0100
Subject: [PATCH] docs: Add descriptive comments for num_jugs and difficulty
 parameters

---
 reasoning_gym/algorithmic/jugs.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/reasoning_gym/algorithmic/jugs.py b/reasoning_gym/algorithmic/jugs.py
index bd5bf020..3f93a409 100644
--- a/reasoning_gym/algorithmic/jugs.py
+++ b/reasoning_gym/algorithmic/jugs.py
@@ -225,8 +225,8 @@ def generate_jug_solution(jug_capacities: Tuple[int, int, int], target: int) ->
 class JugsConfig:
     """Configuration for Jugs puzzle generation"""
 
-    num_jugs: int = 3
-    difficulty: int = 10
+    num_jugs: int = 3  # Number of jugs in the puzzle (affects puzzle complexity and solution space)
+    difficulty: int = 10  # Minimum required moves to solve the puzzle. Also affects max jug capacity (3 + difficulty)
     seed: Optional[int] = None
     size: int = 500