Common: Add a docstring to OperatingSystems

2022-06-24 07:36:58 -04:00 · 2022-06-24 07:36:58 -04:00 · a3db4142bf
parent 2eb1691030
commit a3db4142bf
1 changed files with 7 additions and 0 deletions
--- a/monkey/common/operating_systems.py
+++ b/monkey/common/operating_systems.py
@ -2,5 +2,12 @@ from enum import Enum


 class OperatingSystems(Enum):
+    """
+    An Enum representing all supported operating systems
+
+    This Enum represents all operating systems that Infection Monkey supports. The value of each
+    member is the member's name in all lower-case characters.
+    """
+
    LINUX = "linux"
    WINDOWS = "windows"