From 9cde150bd12b771ba607b9e62918c57ca724ef88 Mon Sep 17 00:00:00 2001
From: Ben Doherty <ben@thinkoomph.com>
Date: Thu, 26 May 2016 21:38:31 -0400
Subject: Add RETURN documentation

---
 files/archive.py | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'files')

diff --git a/files/archive.py b/files/archive.py
index 76dcb9cf..e64a9197 100644
--- a/files/archive.py
+++ b/files/archive.py
@@ -50,6 +50,27 @@ EXAMPLES = '''
     compression: bz2
 '''
 
+RETURN = '''
+state:
+    description: The current state of the archived file.
+    type: string
+    returned: always
+missing:
+    description: Any files that were missing from the source.
+    type: list
+    returned: success
+archived:
+    description: Any files that were compressed or added to the archive.
+    type: list
+    returned: success
+arcroot:
+    description: The archive root.
+    type: string
+expanded_paths:
+    description: The list of matching paths from paths argument.
+    type: list
+'''
+
 import stat
 import os
 import errno
-- 
cgit v1.2.1