summaryrefslogtreecommitdiff
path: root/docs/yaml/objects/module.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/yaml/objects/module.yaml')
-rw-r--r--docs/yaml/objects/module.yaml13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/yaml/objects/module.yaml b/docs/yaml/objects/module.yaml
new file mode 100644
index 000000000..cd98faa5e
--- /dev/null
+++ b/docs/yaml/objects/module.yaml
@@ -0,0 +1,13 @@
+name: module
+long_name: Imported module object
+description: |
+ Base type for all modules.
+
+ Modules provide their own specific implementation methods, but all modules
+ proivide the following methods:
+
+methods:
+- name: found
+ returns: bool
+ since: 0.59.0
+ description: Returns `true` if the module was successfully imported, otherwise `false`.