Common: Add docstring to PluginConfiguration dataclass

This commit is contained in:
Shreya Malviya 2022-07-26 16:42:06 +05:30
parent 775ef144a5
commit fad0c5fe4d
1 changed files with 19 additions and 0 deletions

View File

@ -27,6 +27,25 @@ class CustomPBAConfiguration:
@dataclass(frozen=True)
class PluginConfiguration:
"""
Dataclass for the configuration of plugins
:param name: Name of the plugin.
Example: "ransomware"
:param options: Any other information/configuration fields relevant to the plugin.
Example: {
"encryption": {
"enabled": True,
"directories": {
"linux_target_dir": "~/this_dir",
"windows_target_dir": "C:\that_dir"
},
},
"other_behaviors": {
"readme": True
},
}
"""
name: str
options: Dict