procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix doc strings in desktop.el

Browse source 
* lisp/desktop.el (desktop-auto-save-timeout)
(desktop-auto-save-set-timer): Doc fixes.  (Bug#28945)
This commit is contained in:
Eli Zaretskii 2017-10-28 15:11:08 +03:00
parent 9102fb603e
commit d43b486f6c
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lisp/desktop.el
View file

@ -216,8 +216,9 @@ determine where the desktop is saved."
:version "22.1") :version "22.1")
(defcustom desktop-auto-save-timeout auto-save-timeout (defcustom desktop-auto-save-timeout auto-save-timeout
"Number of seconds idle time before auto-save of the desktop. "Number of seconds of idle time before auto-saving the desktop.
The idle timer activates auto-saving only when window configuration changes. The desktop will be auto-saved when this amount of idle time have
passed after some change in the window configuration.
This applies to an existing desktop file when `desktop-save-mode' is enabled. This applies to an existing desktop file when `desktop-save-mode' is enabled.
Zero or nil means disable auto-saving due to idleness." Zero or nil means disable auto-saving due to idleness."
:type '(choice (const :tag "Off" nil) :type '(choice (const :tag "Off" nil)
@ -1362,10 +1363,11 @@ Called by the timer created in `desktop-auto-save-set-timer'."
(desktop-save desktop-dirname nil t))) (desktop-save desktop-dirname nil t)))
(defun desktop-auto-save-set-timer () (defun desktop-auto-save-set-timer ()
"Set the auto-save timer. "Set the desktop auto-save timer.
Cancel any previous timer. When `desktop-auto-save-timeout' is a positive Cancel any previous timer. When `desktop-auto-save-timeout' is a positive
integer, start a new idle timer to call `desktop-auto-save' repeatedly integer, start a new idle timer to call `desktop-auto-save' after that many
after that many seconds of idle time." seconds of idle time.
This function is called from `window-configuration-change-hook'."
(desktop-auto-save-cancel-timer) (desktop-auto-save-cancel-timer)
(when (and (integerp desktop-auto-save-timeout) (when (and (integerp desktop-auto-save-timeout)
(> desktop-auto-save-timeout 0)) (> desktop-auto-save-timeout 0))