From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Unknown Newsgroups: gmane.emacs.bugs Subject: bug#45750: 28.0.50; [PATCH] Minor shortdoc link improvements Date: Sun, 10 Jan 2021 00:27:35 +0100 Message-ID: References: Reply-To: =?UTF-8?Q?Reply-to=3A_Daniel_Mart=C3=83=C2=ADn_=3Cmardani29=40yahoo=2Ees?= =?UTF-8?Q?=3E=0A?= Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="15666"; mail-complaints-to="usenet@ciao.gmane.io" To: 45750@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jan 10 00:28:21 2021 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 1kyNee-0003xd-GI for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 10 Jan 2021 00:28:20 +0100 Original-Received: from localhost ([::1]:35736 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kyNed-0001Yi-1m for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 09 Jan 2021 18:28:19 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:40168) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kyNeP-0001YP-T7 for bug-gnu-emacs@gnu.org; Sat, 09 Jan 2021 18:28:05 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:41175) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kyNeM-0001nx-BG for bug-gnu-emacs@gnu.org; Sat, 09 Jan 2021 18:28:05 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kyNeM-0003NZ-5j for bug-gnu-emacs@gnu.org; Sat, 09 Jan 2021 18:28:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Daniel =?UTF-8?Q?Mart=C3=ADn?= Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 09 Jan 2021 23:28:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 45750 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.161023487112970 (code B ref -1); Sat, 09 Jan 2021 23:28:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 9 Jan 2021 23:27:51 +0000 Original-Received: from localhost ([127.0.0.1]:52721 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kyNeA-0003N8-Oi for submit@debbugs.gnu.org; Sat, 09 Jan 2021 18:27:51 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:58108) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kyNe7-0003My-D7 for submit@debbugs.gnu.org; Sat, 09 Jan 2021 18:27:49 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:40128) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kyNe7-0001Wj-5x for bug-gnu-emacs@gnu.org; Sat, 09 Jan 2021 18:27:47 -0500 Original-Received: from sonic314-20.consmr.mail.ir2.yahoo.com ([77.238.177.146]:43695) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kyNe4-0001i1-B9 for bug-gnu-emacs@gnu.org; Sat, 09 Jan 2021 18:27:46 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yahoo.es; s=s2048; t=1610234860; bh=91W6sMGH0MXKqHlEJyfEMdgBO6qzieTPCfzBoje4tLk=; h=From:To:Subject:Date:References:From:Subject; b=YP2na5+Yvx/ZaPxYE3tjRfaHgxLuhv+JJn+9sVP3kF/vsVd6cTBU2zZSL+eE2WcQ5bKkOTURkxXqUiqtbbEdQMLvpzDRMAaIWrRXMXGi+l6d5iLLs/BX07JI5FYUuZP6rSlHa7U190hfKCIz1h9sTcg8dSx3JAMY/irtNp/Wemqr3P81ZJAbKxgBXaIn/tv+FVjkPx4kWirBN3xBJ2a6NkXKrBFoExQyJxdalfGSWExEJ6LMxpBg6mpoWxSogVXsZm54LlVsZ/tle6+QmMcr0fHOw8iIxbSEeqM5hK+8irwrucCX2M4XJ1fuXbozVWaVUAESdZCsSqVy+IGOnhJzjA== X-SONIC-DKIM-SIGN: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yahoo.com; s=s2048; t=1610234860; bh=ZdrEiCMUViCE3uu6Ml8+vICAlEyls5l1/n+E5mx4GQY=; h=From:To:Subject:Date:From:Subject; b=uRsCnyAZRfPjmOy3J30PBhZ90tmoJ3vMKM4b+F5OkL2Ek5ozvFc7uAppg4EGWfz7GRr2D/1teyM/jroCwTVcjXh+lkDPPvqzSJyEHopnVVb9WibkQIVY/v6kfoxCUAc/BtNcGW0uI+wiA4Xgz2tUNLlq+zpbSgbdnH5vjdSrSlQz4aPpbDDkhVe2XzeoAjKOR0z9ud8hKTmWF504d3UG6mZLWb9uhJ9+zED3/YmLo8bWUNVARCAUiLKw39UGPG+JAnBMwpJXSTsn8pFK95Nt8DoG5z0iJHvXConyq3FwqISSB/4cCxvqCsrJ3eetqDTYEFyCdJyKcNzTm2jSiUee+Q== X-YMail-OSG: JI2bnp4VM1l6dw2r56hxMn_NY1KJ2E_JZ2liTvEyR02SytvEDrqJrajrBvWsRHy UhAsQX_KhCvYlFaIKA4iRC7Lxu90Vkcb6zBrgqnwgIoD8gTSZvsj43_QcYwoFNRTnclpX4u0f.TO r0xiaaQ3BUjaYBF.31I4eDP_o40JlzmNXt0J7eM5LDcNE2NmYMEW75ZKy6pw4zYg0XAnz3BafGtK w1b2KzaiKzzh4zIm76mF_Q9XOnZZtDw99tYBGn__QKS2sJIMTnAQy0ZyCnGGPrCCLa4bAmV2rizz gEFmzCHVRyjhg8.wSemLLaRczXfWvxHgoulMeWEQc1QSB11AHJouIGOvUA3siMxC8zw46C3f.80e K0shw9o4QJ45IZwtq1ueg4jzR1Cbzu.8.rTlv5OC9WwEaGKKmAsRpZk20k4vqUxHUhW7Uq9WkQZK aIVkSH_KZOzSRprUA12Y2KZO6aWzxDrAAZUD_yCzId6l8rl2Mv7Ig8p.AXMSxRiBqaqq71AoWZgP E.GO_c7tLYb1CFTS_Z2tLFS2aB594XFr.1Scz3WEnmV4BVOAFWu7U30PSBni33gIyS6xpWF5pPI4 ReL1_eb5FNrawgWLlcYYLj60BF3kZttNouiIxbadI2_fvkgAKmc8336inKQxMrDxPwWCNMCFAudF hemNcvuLPBK5DHd_pRA5BUs9pfyiZ3W4VEwYMN6_4EceFev2Wz7SnpD0uBlbMzrIYWWs1BvAjy5H xc.6X8rr0YxzR0Gz7IARKLjsA.LUIyKhimW0KWAkesmgnZ_f_yRkqy0gX8EbTTas6UKiahfHD5Pl z3jtKqUvBtBiO7fIhNi0Q0n73X3mctTmvvnwxUZYiw Original-Received: from sonic.gate.mail.ne1.yahoo.com by sonic314.consmr.mail.ir2.yahoo.com with HTTP; Sat, 9 Jan 2021 23:27:40 +0000 Original-Received: by smtp410.mail.ir2.yahoo.com (VZM Hermes SMTP Server) with ESMTPA ID a1b92694d3e59f7a4177cab657e88b25; Sat, 09 Jan 2021 23:27:36 +0000 (UTC) X-Mailer: WebService/1.1.17501 mail.backend.jedi.jws.acl:role.jedi.acl.token.atz.jws.hermes.yahoo Apache-HttpAsyncClient/4.1.4 (Java/11.0.8) Received-SPF: pass client-ip=77.238.177.146; envelope-from=mardani29@yahoo.es; helo=sonic314-20.consmr.mail.ir2.yahoo.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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" Original-From: Xref: news.gmane.io gmane.emacs.bugs:197574 Archived-At: --=-=-= Content-Type: text/plain Tags: patch Attached is a patch with a couple of minor improvements for the shortdoc feature: - Links now show help-echo and are activated with the mouse in a similar way to the rest of the *Help* buttons. - When a function is marked as :no-manual, instead of showing no link, we now show a link to open the function's description. That still provides a bit more information than the shortdoc and may be a better fallback than showing no link. Thanks. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Minor-improvements-for-the-shortdoc-feature.patch >From 1860b01b0ca10a67f56a109aa0087ec39be8df34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=ADn?= Date: Sat, 9 Jan 2021 23:51:01 +0100 Subject: [PATCH] Minor shortdoc link improvements * lisp/emacs-lisp/shortdoc.el (shortdoc--display-function): Use describe-function as a fallback link when a function is not documented in any Info manual. Also make the link respond to mouse-1, like the rest of *Help* links, and add a proper help-echo property. * lisp/help-fns.el (help-fns--mention-shortdoc-groups): Same link improvement as described before, this time for the shortdoc groups. --- lisp/emacs-lisp/shortdoc.el | 13 +++++++++++-- lisp/help-fns.el | 4 +++- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el index 698467e939..39e69f5aab 100644 --- a/lisp/emacs-lisp/shortdoc.el +++ b/lisp/emacs-lisp/shortdoc.el @@ -1126,12 +1126,21 @@ shortdoc--display-function (insert (propertize "(" 'shortdoc-function t)) (if (plist-get data :no-manual) - (insert (symbol-name function)) + (insert-text-button + (symbol-name function) + 'face 'button + 'action (lambda (_) + (describe-function function)) + 'follow-link t + 'help-echo (purecopy "mouse-1, RET: describe function")) (insert-text-button (symbol-name function) 'face 'button 'action (lambda (_) - (info-lookup-symbol function 'emacs-lisp-mode)))) + (info-lookup-symbol function 'emacs-lisp-mode)) + 'follow-link t + 'help-echo (purecopy "mouse-1, RET: show \ +function's documentation in the Info manual"))) (setq arglist-start (point)) (insert ")\n") ;; Doc string. diff --git a/lisp/help-fns.el b/lisp/help-fns.el index afbb5e3649..d559221a82 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -713,7 +713,9 @@ help-fns--mention-shortdoc-groups (insert-text-button (symbol-name group) 'action (lambda (_) - (shortdoc-display-group group)))) + (shortdoc-display-group group)) + 'follow-link t + 'help-echo (purecopy "mouse-1, RET: show documentation group"))) groups) (insert (if (= (length groups) 1) " group.\n" -- 2.28.0 --=-=-=--