From f8c04cb9902fb8439ba4345404a540d260e4f08c Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Tue, 9 Nov 2021 20:34:18 +0100 Subject: [PATCH] Fix docs issues. (#232) (#233) (cherry picked from commit 523393626251d1bcdb44cc00fa1cd52f59c5a851) Co-authored-by: Felix Fontein --- plugins/modules/docker_container.py | 2 +- plugins/modules/docker_host_info.py | 2 +- plugins/modules/docker_login.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plugins/modules/docker_container.py b/plugins/modules/docker_container.py index 82b8b429..85d5ff17 100644 --- a/plugins/modules/docker_container.py +++ b/plugins/modules/docker_container.py @@ -701,7 +701,7 @@ options: to the first port of the destination range, but to a free port in that range. This is the same behavior as for C(docker) command line utility. - "Bind addresses must be either IPv4 or IPv6 addresses. Hostnames are *not* allowed. This - is different from the C(docker) command line utility. Use the L(dig lookup,../lookup/dig.html) + is different from the C(docker) command line utility. Use the R(dig lookup,ansible_collections.community.general.dig_lookup) to resolve hostnames." - A value of C(all) will publish all exposed container ports to random host ports, ignoring any other mappings. Use I(publish_all_ports) instead as the use of C(all) will be deprecated in version 2.0.0. diff --git a/plugins/modules/docker_host_info.py b/plugins/modules/docker_host_info.py index 0eae50c7..a3e71d89 100644 --- a/plugins/modules/docker_host_info.py +++ b/plugins/modules/docker_host_info.py @@ -88,7 +88,7 @@ options: description: - When set to C(yes) and I(networks), I(volumes), I(images), I(containers) or I(disk_usage) is set to C(yes) then output will contain verbose information about objects matching the full output of API method. - For details see the documentation of your version of Docker API at L(https://docs.docker.com/engine/api/). + For details see the documentation of your version of Docker API at U(https://docs.docker.com/engine/api/). - The verbose output in this module contains only subset of information returned by I(_info) module for each type of the objects. type: bool diff --git a/plugins/modules/docker_login.py b/plugins/modules/docker_login.py index 7cbcd003..5f98f0d0 100644 --- a/plugins/modules/docker_login.py +++ b/plugins/modules/docker_login.py @@ -75,7 +75,7 @@ extends_documentation_fragment: requirements: - "L(Docker SDK for Python,https://docker-py.readthedocs.io/en/stable/) >= 1.8.0 (use L(docker-py,https://pypi.org/project/docker-py/) for Python 2.6)" - - "L(Python bindings for docker credentials store API) >= 0.2.1 + - "Python bindings for docker credentials store API >= 0.2.1 (use L(docker-pycreds,https://pypi.org/project/docker-pycreds/) when using Docker SDK for Python < 4.0.0)" - "Docker API >= 1.20" author: