Add an example of complex return argument (#28610)

2024-09-14 20:13:21 +02:00 · 2017-09-20 09:51:45 -05:00 · 2017-09-20 09:51:45 -05:00 · 700a032bf1
commit 700a032bf1
parent 7596826ed0
1 changed files with 23 additions and 1 deletions
--- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst
+++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst
@ -335,8 +335,30 @@ Example::
        returned: when supported
        type: string
        sample: 2a5aeecc61dc98c4d780b14b330e3282
-    ...
+    '''

+    RETURN = '''
+    packages:
+        description: Information about package requirements
+        returned: On success
+        type: complex
+        contains:
+            missing:
+                description: Packages that are missing from the system
+                returned: success
+                type: list
+                sample:
+                    - libmysqlclient-dev
+                    - libxml2-dev
+            badversion:
+                description: Packages that are installed but at bad versions.
+                returned: success
+                type: list
+                sample:
+                    - package: libxml2-dev
+                      version: 2.9.4+dfsg1-2
+                      constraint: ">= 3.0"
+    '''

 .. note::