diff options
| author | Joffrey F <joffrey@docker.com> | 2017-01-18 15:38:53 -0800 |
|---|---|---|
| committer | Joffrey F <joffrey@docker.com> | 2017-01-18 15:38:53 -0800 |
| commit | 66d57333981f1f8a0f46c6c90a71c1ad020b0ac1 (patch) | |
| tree | ac7bb5b2731d40aaed71b4944014ab28e5ee7913 /docker/models/networks.py | |
| parent | 91a185d7a57464d2b8826d48495bde02098a0079 (diff) | |
| download | docker-py-docs-fixes.tar.gz | |
Fix a number of docs formatting issuesdocs-fixes
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docker/models/networks.py')
| -rw-r--r-- | docker/models/networks.py | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docker/models/networks.py b/docker/models/networks.py index d5e2097..a80c9f5 100644 --- a/docker/models/networks.py +++ b/docker/models/networks.py @@ -32,17 +32,18 @@ class Network(Model): container (str): Container to connect to this network, as either an ID, name, or :py:class:`~docker.models.containers.Container` object. - aliases (list): A list of aliases for this endpoint. Names in that - list can be used within the network to reach the container. - Defaults to ``None``. - links (list): A list of links for this endpoint. Containers - declared in this list will be linkedto this container. - Defaults to ``None``. + aliases (:py:class:`list`): A list of aliases for this endpoint. + Names in that list can be used within the network to reach the + container. Defaults to ``None``. + links (:py:class:`list`): A list of links for this endpoint. + Containers declared in this list will be linkedto this + container. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to ``None``. - link_local_ips (list): A list of link-local (IPv4/IPv6) addresses. + link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) + addresses. Raises: :py:class:`docker.errors.APIError` @@ -167,8 +168,8 @@ class NetworkCollection(Collection): List networks. Similar to the ``docker networks ls`` command. Args: - names (list): List of names to filter by. - ids (list): List of ids to filter by. + names (:py:class:`list`): List of names to filter by. + ids (:py:class:`list`): List of ids to filter by. Returns: (list of :py:class:`Network`) The networks on the server. |