mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 22:41:06 -08:00
Code Issues Projects Releases Wiki Activity

; Improve doc strings of some igc functions

Browse source 
* src/igc.c (Figc__arena_step):
* lisp/emacs-lisp/igc.el (igc--current-idle-time, igc--on-idle):
Doc fixes.
This commit is contained in:
Eli Zaretskii 2025-12-06 15:15:50 +02:00
parent e0517ecbe6
commit 03b258fe44
2 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lisp/emacs-lisp/igc.el
View file

@ -491,6 +491,8 @@ This function is called from a timer; see `igc-start-collecting-stats'."
(defun igc--current-idle-time ()
"Time since the last command finished, in seconds as a float.
This calls `current-idle-time', then converts the return value
to a float number of seconds.
See `igc--on-idle'."
(let ((idle-time (current-idle-time)))
(if idle-time (float-time idle-time) 0)))
@ -514,8 +516,8 @@ See `igc--on-idle'."
(defun igc--on-idle (state repetition)
"Timer function to do GC in idle Emacs state.
Calls igc--arena-step, wrapper for mps_arena_step for this very purpose.
See `igc-start-idle-timer."
Calls `igc--arena-step', wrapper for mps_arena_step for this very purpose.
See `igc-start-idle-timer'."
(let ((timer2 (aref state 0)))
(when timer2
(cancel-timer timer2)))