Add output example to Queue.__generate_json_data docstring

ECN · Jun 29, 2021 · 3408d37 · 3408d37
1 parent 0e8b1dc
commit 3408d37
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/webqueue2api/parser/queue.py b/src/webqueue2api/parser/queue.py
@@ -40,7 +40,11 @@ def __generate_json_data(self) -> dict:
 
         Example:
                 __generate_json_data() returns:
-                ...
+                {
+                    'items': [ ...items ],
+                    'name': 'ce',
+                    'path': '/home/pier/e/queue/Mail/ce'
+                }
 
         Returns:
                 dict: JSON serializable data dictionary of class attributes.