Common: Add docstring to PluginConfiguration dataclass
This commit is contained in:
parent
775ef144a5
commit
fad0c5fe4d
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in New Issue