Common: Fix docstring format in PluginConfiguration

This commit is contained in:
Shreya Malviya 2022-07-27 13:12:45 +05:30
parent f941c2aa35
commit 856ce4925b
1 changed files with 16 additions and 14 deletions

View File

@ -30,22 +30,24 @@ class PluginConfiguration:
"""
A configuration for 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"
Attributes:
: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
},
}
"other_behaviors": {
"readme": True
},
}
"""
name: str
options: Dict