api: update return type of diff method (#3115)

Signed-off-by: John Yang <john.yang20@berkeley.edu>
docker · May 5, 2023 · 576e47a · 576e47a
1 parent 3178c8d
commit 576e47a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docker/api/container.py b/docker/api/container.py
@@ -678,7 +678,8 @@ def diff(self, container):
             container (str): The container to diff
 
         Returns:
-            (str)
+            (list) A list of dictionaries containing the attributes `Path`
+                and `Kind`.
 
         Raises:
             :py:class:`docker.errors.APIError`

diff --git a/docker/models/containers.py b/docker/models/containers.py
@@ -141,7 +141,8 @@ def diff(self):
         Inspect changes on a container's filesystem.
 
         Returns:
-            (str)
+            (list) A list of dictionaries containing the attributes `Path`
+                and `Kind`.
 
         Raises:
             :py:class:`docker.errors.APIError`