Add note explaining docker dict details for GH actions

simphony · Jul 27, 2021 · d8ec906 · d8ec906
1 parent 93527ce
commit d8ec906
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/remoteappmanager/docker/container.py b/remoteappmanager/docker/container.py
@@ -92,6 +92,13 @@ def from_docker_dict(cls, docker_dict):
         >>> containers = docker.Client().containers()
 
         >>> Container.from_docker_dict(containers[0])
+
+        Notes
+        -----
+        On GitHub Actions, the Ports key of the docker dict contains two
+        elements, with the first one having the proper HostIp and the other
+        having a '::' HostIp. We can safely assume the first one is the valid
+        one, and raise an exception in any other case.
         """
 
         is_inspect_container_output = ("Config" in docker_dict)