Update docstring to Google style

testcontainers · Jun 27, 2023 · 2c4eb3b · 2c4eb3b
1 parent b1b4811
commit 2c4eb3b
Showing 1 changed file with 11 additions and 21 deletions.
diff --git a/core/testcontainers/core/container.py b/core/testcontainers/core/container.py
@@ -14,27 +14,17 @@ class DockerContainer:
     """
     Basic container object to spin up Docker instances.
 
-    Parameters
-    ----------
-    image:
-        The name of the image to start.
-    docker_client_kw:
-        Dictionary with arguments that will be passed to the
-        docker.DockerClient init.
-    command:
-        Optional execution command for the container.
-    name:
-        Optional name for the container.
-    ports:
-        Ports to be exposed by the container. The port number will be
-        automatically assigned on the host, use :code:`get_exposed_port(PORT)`
-        method to get the port number on the host.
-    volumes:
-        Volumes to mount into the container. Each entry should be a tuple with
-        three values:
-        #. host path
-        #. container path
-        #. mode (default 'ro').
+    Args:
+        image: The name of the image to start.
+        docker_client_kw: Dictionary with arguments that will be passed to the
+            docker.DockerClient init.
+        command: Optional execution command for the container.
+        name: Optional name for the container.
+        ports: Ports to be exposed by the container. The port number will be
+            automatically assigned on the host, use
+            :code:`get_exposed_port(PORT)` method to get the port number on the host.
+        volumes: Volumes to mount into the container. Each entry should be a tuple with
+            three values: host path, container path and. mode (default 'ro').
 
     .. doctest::