From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#68684: [PATCH] dictonary.el documentation Date: Tue, 24 Dec 2024 03:15:14 +0000 Message-ID: References: <8734uof4m4.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16670"; mail-complaints-to="usenet@ciao.gmane.io" Cc: torsten.hilbrich@gmx.net, iarchivedmywholelife@gmail.com To: 68684-done@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Dec 24 04:17:30 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tPvQH-0004BB-OE for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 24 Dec 2024 04:17:30 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tPvPt-0003Ip-Mv; Mon, 23 Dec 2024 22:17:05 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tPvPr-0003Hn-7q for bug-gnu-emacs@gnu.org; Mon, 23 Dec 2024 22:17:04 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tPvPq-0004zd-Uy for bug-gnu-emacs@gnu.org; Mon, 23 Dec 2024 22:17:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=Date:MIME-Version:References:In-Reply-To:From:To:Subject; bh=yzBq+RQkao7ED5AOyRW2GwYryi7YNhQ20kxQMms7FWM=; b=fyU4Sj3DpawwXHhYFPalWfS/HdwUhGe4zjQSUitABUU3oj5elsaJ1FwpEgNjxTc2Jz240eZkP37s2b0LTPGnU78AgYq2/bP0AYm0hRaIWPltOZ2UOyOv/rzsD8QpgDzqGWM9cPhKHwf7SoiIVQL/7WAZ0Rv2HUQRdZTBGlOSA7J6Prix/iUmGCUhbcaKiXe3sPf5KYh0XY+AfFwx4uvl4YITER9mUt5ZLMBqfipuUanUn+RXsBLH+X8VojhExS+vs01DJQu5Oq5a+zIlZUmBZlVvIrUKmV2voHq0w0PpmhCUJJUKBtMqUG7eYWcHJ2Dx/G021C+HR+dvkXG1vVhq5g==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tPvPq-00043s-E6 for bug-gnu-emacs@gnu.org; Mon, 23 Dec 2024 22:17:02 -0500 Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Tue, 24 Dec 2024 03:17:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 68684 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Mail-Followup-To: 68684@debbugs.gnu.org, stefankangas@gmail.com, stefankangas@gmail.com Original-Received: via spool by 68684-done@debbugs.gnu.org id=D68684.173501018315533 (code D ref 68684); Tue, 24 Dec 2024 03:17:02 +0000 Original-Received: (at 68684-done) by debbugs.gnu.org; 24 Dec 2024 03:16:23 +0000 Original-Received: from localhost ([127.0.0.1]:58836 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tPvPC-00042S-ND for submit@debbugs.gnu.org; Mon, 23 Dec 2024 22:16:23 -0500 Original-Received: from mail-ed1-f54.google.com ([209.85.208.54]:61788) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tPvPA-00042E-Dv for 68684-done@debbugs.gnu.org; Mon, 23 Dec 2024 22:16:20 -0500 Original-Received: by mail-ed1-f54.google.com with SMTP id 4fb4d7f45d1cf-5d3d0205bd5so6468076a12.3 for <68684-done@debbugs.gnu.org>; Mon, 23 Dec 2024 19:16:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1735010114; x=1735614914; darn=debbugs.gnu.org; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:from:to:cc:subject:date:message-id:reply-to; bh=yzBq+RQkao7ED5AOyRW2GwYryi7YNhQ20kxQMms7FWM=; b=hN5UCyeo47Ix+w39mFbTL8HhkjxSvgAY2kfsv2hVXzYktP3ABOmC/ANqURsGtHkDgF 6oFI+XWiPyekLzFhGspSlJBI1NZM4XYD2vml8Fr4vJFl4N9h2eDlRUBBTDZr4H1nUEV6 uSuj3NIjTBsg5U8VdhmUp7szYsDAWAsQ4uUkXH5g27k3FLkaBYP0bPlF8NbHMjWSpcxi dZQN+rnMrJxI/RPd7BFG4JFf965iqlrgms5rbCVv5P/WER/0o1bGS1bZgRiRfL8NMA98 IoZLDLkH580rngv4oSu2j0z41UOrgOyr8qwk5KSzCfYpJQn/b8FxaJw6DHVa0aruKSCU Kj4Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1735010114; x=1735614914; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=yzBq+RQkao7ED5AOyRW2GwYryi7YNhQ20kxQMms7FWM=; b=R9fstGJrlamrdFa+uR7ydJ1EZi+2Xts4NoV4XcuCNAFljbCAJeGHsNC10dhabN4wXY W/7AbfWusgeS7TXuVg5sC4jT2PcD3Eex9N0k7xc8KFxhiO+8aB6+qaB0YliRsQlHSnAe 8P4S2DGEW4Akp5xEQ2ViTDgBBuoIauXgu/GS3z+RPZA+S2m3mTTRwvhOnjffOAwoq66e +Nfid8b6kZjuuh03usXncp/hbyAcTCGVQ1jXMcxK4pMq0AITTjQdrXt9ZUhLNNPpPXv0 sRRBp4Wiy60WHsppYY/4S6UiMmq+l1vMGKstKIye3X9+H/roF+RjMfsxX/NHiVQNMAcU PnBg== X-Gm-Message-State: AOJu0YwofSvvTwD0U5Ib5xaYpKqmGl8mLsEVQEnhPjgwfAZ1lziLNQM1 4l4/DrUho+FVBZQDgPjJ0Q2cvSC2rRXL6mrh0GtqxmCIHwl1gVLLmZ9vdpwckW544yzfyu7sZz6 6jmuEqXPZ3vrcT/tgjmmLeFI6RKR8dBaEGxs= X-Gm-Gg: ASbGncsx6ziaH/Skzcf9tAbDIhvlLYlsduckfvZiNmRrVf3Z6abwJe1s7O9DsfyYYrs YWdXG3EqHxsdVy1uEUJM6rL/7Otm/mCKSxYIpUbw= X-Google-Smtp-Source: AGHT+IEU0ejQ2Bu4NKmH/ovKZdPTtkV/OQKzv/N1M4D+y/nJsjJfhnrGC6Ux88jp4N2vjYaeLZnHWdjWyHTZz/0A9+I= X-Received: by 2002:a05:6402:4402:b0:5cf:e9d6:cc8a with SMTP id 4fb4d7f45d1cf-5d81dda9256mr13963429a12.20.1735010114273; Mon, 23 Dec 2024 19:15:14 -0800 (PST) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Tue, 24 Dec 2024 03:15:14 +0000 In-Reply-To: (Stefan Kangas's message of "Wed, 24 Jan 2024 02:15:12 -0800") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:297677 Archived-At: Version: 31.1 Stefan Kangas writes: > Severity: wishlist > > -------------------- Start of forwarded message -------------------- > From: No Wayman > To: emacs-devel@gnu.org > Subject: [PATCH] dictonary.el documentation > Date: Tue, 23 Jan 2024 10:31:47 -0500 > Pushed to master, thanks. Closing. > > From 02c4f83176ab9fb1afdb3962f9b90023961ebaaa Mon Sep 17 00:00:00 2001 > From: Nicholas Vollmer > Date: Tue, 23 Jan 2024 09:39:02 -0500 > Subject: [PATCH] * lisp/net/dictionary.el: satisfy checkdoc > > (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 > --- > lisp/net/dictionary.el | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/lisp/net/dictionary.el b/lisp/net/dictionary.el > index 1981b757017..4f4710a2920 100644 > --- a/lisp/net/dictionary.el > +++ b/lisp/net/dictionary.el > @@ -461,7 +461,7 @@ dictionary-tool-bar-map > :vert-only t > :help "Go backwards in history.") > map) > - "Like the default `tool-bar-map', but with additions for Dictionary mode") > + "Like the default `tool-bar-map', but with additions for Dictionary mode.") > > ;;;###autoload > (define-derived-mode dictionary-mode special-mode "Dictionary" > @@ -1316,7 +1316,7 @@ dictionary-popup-matching-words > 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) > @@ -1360,7 +1360,7 @@ dictionary-definition > (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"))) > > @@ -1381,7 +1381,7 @@ dictionary-word-at-mouse-event > (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) > @@ -1396,7 +1396,7 @@ dictionary-display-tooltip > 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 > @@ -1404,7 +1404,7 @@ dictionary-tooltip-track-mouse > (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