From 2ea3a272633d2bfec6a9c179914e00f89d67127e Mon Sep 17 00:00:00 2001
From: Shreya Malviya <shreya.malviya@gmail.com>
Date: Wed, 27 Jul 2022 18:08:30 +0530
Subject: [PATCH] Common: Add docstring to PropagationConfiguration dataclass

---
 .../agent_configuration/agent_sub_configurations.py      | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/monkey/common/agent_configuration/agent_sub_configurations.py b/monkey/common/agent_configuration/agent_sub_configurations.py
index ab05a55cc..6fd9e5afd 100644
--- a/monkey/common/agent_configuration/agent_sub_configurations.py
+++ b/monkey/common/agent_configuration/agent_sub_configurations.py
@@ -118,6 +118,15 @@ class ExploitationConfiguration:
 
 @dataclass(frozen=True)
 class PropagationConfiguration:
+    """
+    A configuration for propagation
+
+    Attributes:
+        :param maximum_depth: Maximum number of hops to take from the Island server
+        :param network_scan: Configuration for network scanning
+        :param exploitation: Configuration for exploitation
+    """
+
     maximum_depth: int
     network_scan: NetworkScanConfiguration
     exploitation: ExploitationConfiguration