ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-04 23:44:00 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Avoid having module documentation links to itself (#21329)

Browse source 
* Avoid having module documentation links to itself

A lot of modules use M(own_module) in their documentation causing a link
in the documentation to itself.

* Make note more clear now
This commit is contained in:
Dag Wieers 2017-02-13 15:02:34 +01:00 • committed by John R Barker
commit f824b2ce8d
32 changed files with 40 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/ansible/modules/windows/win_shell.py
View file

@ -29,7 +29,7 @@ module: win_shell
short_description: Execute shell commands on target hosts.
version_added: 2.2
description:
- The M(win_shell) module takes the command name followed by a list of space-delimited arguments.
- The C(win_shell) module takes the command name followed by a list of space-delimited arguments.
It is similar to the M(win_command) module, but runs
the command via a shell (defaults to PowerShell) on the target host.
options:
@ -53,7 +53,7 @@ options:
notes:
- If you want to run an executable securely and predictably, it may be
better to use the M(win_command) module instead. Best practices when writing
playbooks will follow the trend of using M(win_command) unless M(win_shell) is
playbooks will follow the trend of using M(win_command) unless C(win_shell) is
explicitly required. When running ad-hoc commands, use your best judgement.
- WinRM will not return from a command execution until all child processes created have exited. Thus, it is not possible to use win_shell to spawn long-running child or background processes.
Consider creating a Windows service for managing background processes.