From 0a0613f9a3211e7fd486ced534f9dc172db2e20e Mon Sep 17 00:00:00 2001 From: Nicholas Vollmer Date: Tue, 23 Jan 2024 09:39:02 -0500 Subject: [PATCH] Fix checkdoc warnings in dictionary.el * lisp/net/dictionary.el (dictionary-tool-bar-map): Add missing period. (dictionary-process-popup-replies) (dictionary-read-definition) (dictionary-display-tooltip): Rename ignored parameters. (dictionary-tooltip-track-mouse): Describe what function does, not just when. (dictionary-switch-tooltip-mode): Reword docstring in terms of ON parameter. (Bug#68684) (cherry picked from commit 7cda5e7f0272d766bd2090a274faeb7776303f46) --- lisp/net/dictionary.el | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lisp/net/dictionary.el b/lisp/net/dictionary.el index ad3ed0b25d7..6fa0bab2c2b 100644 --- a/lisp/net/dictionary.el +++ b/lisp/net/dictionary.el @@ -1336,7 +1336,7 @@ prompt for DICTIONARY." dictionary-default-popup-strategy 'dictionary-process-popup-replies)) -(defun dictionary-process-popup-replies (&ignore) +(defun dictionary-process-popup-replies (_) (let ((list (dictionary-simple-split-string (dictionary-read-answer) "\n+"))) (let ((result (mapcar (lambda (item) @@ -1391,7 +1391,7 @@ via `dictionary-dictionaries'." (dictionary-do-search word dictionary 'dictionary-read-definition t)) nil)) -(defun dictionary-read-definition (&ignore) +(defun dictionary-read-definition (_) (let ((list (dictionary-simple-split-string (dictionary-read-answer) "\n+"))) (mapconcat #'identity (cdr list) "\n"))) @@ -1418,7 +1418,7 @@ via `dictionary-dictionaries'." (defvar dictionary-tooltip-mouse-event nil "Event that triggered the tooltip mode.") -(defun dictionary-display-tooltip (&ignore) +(defun dictionary-display-tooltip (_) "Search the current word in the `dictionary-tooltip-dictionary'." (interactive "e") (if (and dictionary-tooltip-mode dictionary-tooltip-dictionary) @@ -1442,7 +1442,7 @@ via `dictionary-dictionaries'." nil))) (defun dictionary-tooltip-track-mouse (event) - "Called whenever a dictionary tooltip display is about to be triggered." + "Hide current tooltip and setup next tooltip in response to mouse movement EVENT." (interactive "e") (tooltip-hide) (when dictionary-tooltip-mode @@ -1450,7 +1450,7 @@ via `dictionary-dictionaries'." (tooltip-start-delayed-tip))) (defun dictionary-switch-tooltip-mode (on) - "Turn off or on support for the dictionary tooltip mode. + "Turn dictionary tooltip mode off or ON. It is normally internally called with 1 to enable support for the tooltip mode. The hook function will check the value of the -- 2.39.5