Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docker_swarm inventory plugin: fix some docs formatting #54952

Merged
merged 1 commit into from Apr 8, 2019
Merged

docker_swarm inventory plugin: fix some docs formatting #54952

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions lib/ansible/plugins/inventory/docker_swarm.py
View file
Open in desktop
Expand Up @@ -34,14 +34,14 @@
choices: docker_swarm
docker_host:
description:
- Socket of a Docker swarm manager node (tcp,unix).
- Socket of a Docker swarm manager node (C(tcp), C(unix)).
- "Use C(unix://var/run/docker.sock) to connect via local socket."
type: str
required: true
aliases: [ docker_url ]
verbose_output:
description: Toggle to (not) include all available nodes metadata (e.g. Platform, Architecture,OS,
EngineVersion)
description: Toggle to (not) include all available nodes metadata (e.g. C(Platform), C(Architecture), C(OS),
C(EngineVersion))
type: bool
default: yes
tls:
Expand Down Expand Up @@ -89,10 +89,10 @@
default: 60
aliases: [ time_out ]
include_host_uri:
description: Toggle to return the additional attribute I(ansible_host_uri) which contains the URI of the
swarm leader in format of M(tcp://172.16.0.1:2376). This value may be used without additional
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

M(xyz) creates a link to a module called xyz, which totally doesn't make sense here.

description: Toggle to return the additional attribute C(ansible_host_uri) which contains the URI of the
swarm leader in format of C(tcp://172.16.0.1:2376). This value may be used without additional
modification as value of option I(docker_host) in Docker Swarm modules when connecting via API.
The port always defaults to M(2376).
The port always defaults to C(2376).
type: bool
default: no
include_host_uri_port:
Expand Down