mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-27 15:11:23 -07:00
Windows: Fix documentation strings to be raw strings (#20301)
* Windows: Fix documentation strings to be raw strings Especially when using Windows paths they easily get confused as escaped sequences or unicode characters. So by default use raw strings This fixes #20295 * Fixed as hinted by @abadger And some trailing whitespace fixes.
This commit is contained in:
parent
4ba9f63afe
commit
5b9eb92722
40 changed files with 161 additions and 161 deletions
|
@ -23,7 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
'supported_by': 'core',
|
||||
'version': '1.0'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: win_command
|
||||
short_description: Executes a command on a remote Windows node
|
||||
|
@ -59,24 +59,24 @@ author:
|
|||
- Matt Davis
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r'''
|
||||
# Example from Ansible Playbooks.
|
||||
- win_command: whoami
|
||||
register: whoami_out
|
||||
|
||||
# Run the command only if the specified file does not exist.
|
||||
- win_command: wbadmin -backupTarget:c:\\backup\\ creates=c:\\backup\\
|
||||
- win_command: wbadmin -backupTarget:C:\backup\ creates=C:\backup\
|
||||
|
||||
# You can also use the 'args' form to provide the options. This command
|
||||
# will change the working directory to c:\\somedir\\ and will only run when
|
||||
# c:\\backup\\ doesn't exist.
|
||||
- win_command: wbadmin -backupTarget:c:\\backup\\ creates=c:\\backup\\
|
||||
# will change the working directory to C:\somedir\\ and will only run when
|
||||
# C:\backup\ doesn't exist.
|
||||
- win_command: wbadmin -backupTarget:C:\backup\ creates=C:\backup\
|
||||
args:
|
||||
chdir: c:\\somedir\\
|
||||
creates: c:\\backup\\
|
||||
chdir: C:\somedir\
|
||||
creates: C:\backup\
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r'''
|
||||
msg:
|
||||
description: changed
|
||||
returned: always
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue