use multidoc example in inventory

theforeman · Dec 16, 2024 · 138bc83 · 138bc83
1 parent 5f5ba20
commit 138bc83
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.ansible-lint b/.ansible-lint
@@ -8,6 +8,5 @@ only_builtins_allow_collections:
   - theforeman.foreman
 exclude_paths:
   - meta/runtime.yml
-  - plugins/inventory/foreman.py
   - tests/
   - .github/
diff --git a/plugins/inventory/foreman.py b/plugins/inventory/foreman.py
@@ -174,14 +174,16 @@
         default: ['name']
 '''
 
-EXAMPLES = '''
+EXAMPLES = r'''
+---
 # my.foreman.yml
 plugin: theforeman.foreman.foreman
 url: https://foreman.example.com
 user: ansibleinventory
 password: changeme
 host_filters: 'organization="Web Engineering"'
 
+---
 # shortname.foreman.yml
 plugin: theforeman.foreman.foreman
 url: https://foreman.example.com
@@ -190,6 +192,7 @@
 hostnames:
   - name.split('.')[0]
 '''
+
 import copy
 import json
 from ansible_collections.theforeman.foreman.plugins.module_utils._version import LooseVersion