saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

fix minor doc issues in win_system module

Browse source
This commit is contained in:
Justin Findlay 2015-11-06 14:25:03 -07:00
parent 5828f391b9
commit e8c7371b56
1 changed files with 14 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
salt/modules/win_system.py
View file

@ -133,19 +133,16 @@ def reboot(timeout=5, in_seconds=False):
:param int timeout:
Number of seconds before rebooting the system.
Default is 5 seconds.
Default is 5 minutes.
:return: True if successful
:rtype: bool
timeout
The wait time before the system will be shutdown.
in_seconds
:param bool in_seconds:
Whether to treat timeout as seconds or minutes.
.. versionadded:: 2015.8.0
:return: True if successful
:rtype: bool
CLI Example:
.. code-block:: bash
@ -167,18 +164,18 @@ def shutdown(message=None, timeout=5, force_close=True, reboot=False, in_seconds
seconds. While this dialog box is displayed, the shutdown can be stopped
by the shutdown_abort function.
If dwTimeout is not zero, InitiateSystemShutdown displays a dialog box
on the specified computer. The dialog box displays the name of the user
who called the function, displays the message specified by the lpMessage
parameter, and prompts the user to log off. The dialog box beeps when it
is created and remains on top of other windows in the system. The dialog
box can be moved but not closed. A timer counts down the remaining time
before a forced shutdown.
If timeout is not zero, InitiateSystemShutdown displays a dialog box on
the specified computer. The dialog box displays the name of the user
who called the function, displays the message specified by the
lpMessage parameter, and prompts the user to log off. The dialog box
beeps when it is created and remains on top of other windows in the
system. The dialog box can be moved but not closed. A timer counts down
the remaining time before a forced shutdown.
If dwTimeout is zero, the computer shuts down without displaying the
If timeout is zero, the computer shuts down without displaying the
dialog box, and the shutdown cannot be stopped by shutdown_abort.
Default is 5
Default is 5 minutes
:param bool in_seconds:
Whether to treat timeout as seconds or minutes.
@ -223,10 +220,6 @@ def shutdown_hard():
'''
Shutdown a running system with no timeout or warning.
:param int timeout:
Number of seconds before shutting down the system.
Default is 5 seconds.
:return: True if successful
:rtype: bool