Fix typos, improve markup, improve scenario guide (#699)

* Fix typos.

* Improve markup.

* Mention missing 'new' modules in scenario guide.
This commit is contained in:
Felix Fontein
2023-10-29 08:30:24 +01:00
committed by GitHub
parent fbc2750b6a
commit 1c66f880ee
12 changed files with 72 additions and 60 deletions
+1 -1
View File
@@ -15,7 +15,7 @@ from ansible_collections.community.docker.plugins.module_utils._scramble import
class ActionModule(ActionBase):
# Set to True when transfering files to the remote
# Set to True when transferring files to the remote
TRANSFERS_FILES = False
def run(self, tmp=None, task_vars=None):
+1 -1
View File
@@ -128,7 +128,7 @@ class Connection(ConnectionBase):
# This plugin does not support pipelining. This diverges from the behavior of
# the core "local" connection plugin that this one derives from.
if sudoable and self.become and self.become.expect_prompt():
# Create a pty if sudoable for privlege escalation that needs it.
# Create a pty if sudoable for privilege escalation that needs it.
# Falls back to using a standard pipe if this fails, which may
# cause the command to fail in certain situations where we are escalating
# privileges or the command otherwise needs a pty.
+1 -1
View File
@@ -49,7 +49,7 @@ DOCUMENTATION = '''
default: true
verbose_output:
description:
- When V(true), include all available nodes metadata (for exmaple C(Image), C(Region), C(Size)) as a JSON object
- When V(true), include all available nodes metadata (for example C(Image), C(Region), C(Size)) as a JSON object
named C(docker_machine_node_attributes).
type: bool
default: true
+1 -1
View File
@@ -455,7 +455,7 @@ class APIClient(
return self._get_result_tty(stream, res, self._check_is_tty(container))
def _get_result_tty(self, stream, res, is_tty):
# We should also use raw streaming (without keep-alives)
# We should also use raw streaming (without keep-alive)
# if we're dealing with a tty-enabled container.
if is_tty:
return self._stream_raw_result(res) if stream else \
@@ -132,7 +132,7 @@ class ContainerManager(DockerBaseClass):
self.all_options['image'].comparison = 'ignore'
if self.module.params['purge_networks']:
self.all_options['networks'].comparison = 'strict'
# Process comparsions specified by user
# Process comparisons specified by user
if self.module.params.get('comparisons'):
# If '*' appears in comparisons, process it first
if '*' in self.module.params['comparisons']:
+1 -1
View File
@@ -261,7 +261,7 @@ class LoginManager(DockerBaseClass):
def run(self):
'''
Do the actuall work of this task here. This allows instantiation for partial
Do the actual work of this task here. This allows instantiation for partial
testing.
'''
+1 -1
View File
@@ -266,7 +266,7 @@ EXAMPLES = '''
RETURN = '''
swarm_facts:
description: Informations about swarm.
description: Information about swarm.
returned: success
type: dict
contains: