Skip to content

Commit 2c4eb3b

Browse files
committed
Update docstring to Google style
1 parent b1b4811 commit 2c4eb3b

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

core/testcontainers/core/container.py

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,17 @@ class DockerContainer:
1414
"""
1515
Basic container object to spin up Docker instances.
1616
17-
Parameters
18-
----------
19-
image:
20-
The name of the image to start.
21-
docker_client_kw:
22-
Dictionary with arguments that will be passed to the
23-
docker.DockerClient init.
24-
command:
25-
Optional execution command for the container.
26-
name:
27-
Optional name for the container.
28-
ports:
29-
Ports to be exposed by the container. The port number will be
30-
automatically assigned on the host, use :code:`get_exposed_port(PORT)`
31-
method to get the port number on the host.
32-
volumes:
33-
Volumes to mount into the container. Each entry should be a tuple with
34-
three values:
35-
#. host path
36-
#. container path
37-
#. mode (default 'ro').
17+
Args:
18+
image: The name of the image to start.
19+
docker_client_kw: Dictionary with arguments that will be passed to the
20+
docker.DockerClient init.
21+
command: Optional execution command for the container.
22+
name: Optional name for the container.
23+
ports: Ports to be exposed by the container. The port number will be
24+
automatically assigned on the host, use
25+
:code:`get_exposed_port(PORT)` method to get the port number on the host.
26+
volumes: Volumes to mount into the container. Each entry should be a tuple with
27+
three values: host path, container path and. mode (default 'ro').
3828
3929
.. doctest::
4030

0 commit comments

Comments
 (0)