GNU logs - #77124, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#77124: [PATCH] Optionally display function docstring in eldoc
Resent-From: Elijah Gabe =?UTF-8?Q?P=C3=A9rez?= <eg642616@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 19 Mar 2025 18:33:01 +0000
Resent-Message-ID: <handler.77124.B.17424091666775 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 77124 <at> debbugs.gnu.org
From: Elijah Gabe =?UTF-8?Q?P=C3=A9rez?= <eg642616@HIDDEN>
Date: Wed, 19 Mar 2025 12:32:15 -0600
Message-ID: <871pus50sw.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
Received-SPF: pass client-ip=2607:f8b0:4864:20::343;
 envelope-from=eg642616@HIDDEN; helo=mail-ot1-x343.google.com
X-Spam_score_int: -15
X-Spam_score: -1.6
X-Spam_bar: -
X-Spam_report: (-1.6 / 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, HTML_MESSAGE=0.001,
 HTML_OBFUSCATE_05_10=0.26, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 1.2 (+)
X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.org",
 has NOT identified this incoming email as spam.  The original
 message has been attached to this so you can view it or label
 similar future email.  If you have any questions, see
 the administrator of that system for details.
 Content preview: Tags: patch This user option tell whether 'eldoc' should
 display
 elisp function docstring. If set to 'short' only display a short docstring,
 otherwise if set to 'full', display full docstring. If set to nil do no [...]
 Content analysis details:   (1.2 points, 10.0 required)
 pts rule name              description
 ---- ---------------------- --------------------------------------------------
 1.0 SPF_SOFTFAIL           SPF: sender does not match SPF record (softfail)
 0.2 FREEMAIL_ENVFROM_END_DIGIT Envelope-from freemail username ends
 in digit (eg642616[at]gmail.com)
 -0.0 SPF_HELO_PASS          SPF: HELO matches SPF record
 0.0 FREEMAIL_FROM          Sender email is commonly abused enduser mail
 provider (eg642616[at]gmail.com)
 0.0 HTML_OBFUSCATE_05_10   BODY: Message is 5% to 10% HTML obfuscation
 0.0 HTML_MESSAGE           BODY: HTML included in message
 -0.0 RCVD_IN_DNSWL_NONE     RBL: Sender listed at https://www.dnswl.org/,
 no trust [2001:470:142:0:0:0:0:17 listed in] [list.dnswl.org]
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: 0.2 (/)

--=-=-=
Content-Type: multipart/alternative; boundary="==-=-="

--==-=-=
Content-Type: text/plain

Tags: patch

This user option tell whether 'eldoc' should display elisp function docstring.
If set to 'short' only display a short docstring, otherwise if set to
'full', display full docstring.
If set to nil do not show function docstring.

In GNU Emacs 31.0.50 (build 1, x86_64-redhat-linux-gnu, GTK+ Version
 3.24.43, cairo version 1.18.2) of 2025-03-18 built on
 0dae0d7b05b64c3db75f27d2c3f0cd33
System Description: Fedora Linux 41 (Workstation Edition)




--==-=-=
Content-Type: text/html

<p>
Tags: patch<br />
</p>

<p>
This user option tell whether 'eldoc' should display elisp function docstring.<br />
If set to 'short' only display a short docstring, otherwise if set to<br />
'full', display full docstring.<br />
If set to nil do not show function docstring.<br />
</p>

<p>
In GNU Emacs 31.0.50 (build 1, x86<sub>64</sub>-redhat-linux-gnu, GTK+ Version<br />
 3.24.43, cairo version 1.18.2) of 2025-03-18 built on<br />
 0dae0d7b05b64c3db75f27d2c3f0cd33<br />
System Description: Fedora Linux 41 (Workstation Edition)<br />
</p>

--==-=-=--

--=-=-=
Content-Type: text/patch
Content-Disposition: attachment;
 filename=0001-Optionally-display-function-docstring-in-eldoc.patch

From 1b97cd0dff054c862e81434f1376109bb9d30c66 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?El=C3=ADas=20Gabriel=20P=C3=A9rez?= <eg642616@HIDDEN>
Date: Wed, 19 Mar 2025 12:01:22 -0600
Subject: [PATCH] Optionally display function docstring in eldoc

Allow display (optionally) function docstring in eldoc.
* etc/NEWS: Announce changes.
* lisp/progmodes/elisp-mode.el (elisp-eldoc-var-docstring-with-value):
New user option.
(elisp-get-fnsym-args-string): Display function docstring.
---
 etc/NEWS                     |  7 +++++++
 lisp/progmodes/elisp-mode.el | 24 ++++++++++++++++++++++--
 2 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 0797fc03217..b0a0e6cb6a3 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1900,6 +1900,13 @@ another pattern matching syntax that is different from that of 'pcase',
 which some users might find less cryptic.
 See the Info node "(elisp) cond* Macro" for details.
 
+---
+** New user option 'elisp-eldoc-show-function-docstring'.
+This user option tell whether 'eldoc' should display function docstring.
+If set to 'short' only display a short docstring, otherwise if set to
+'full', display full docstring.
+If set to nil do not show function docstring.
+
 ---
 ** New function 'shell-command-do-open'.
 This lets a Lisp program access the core functionality of the
diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el
index a34f29bffea..761d392be63 100644
--- a/lisp/progmodes/elisp-mode.el
+++ b/lisp/progmodes/elisp-mode.el
@@ -1882,6 +1882,17 @@ elisp-eldoc-var-docstring-with-value
 				   (format "[%sc more]" more)))))
 	       :thing cs
 	       :face 'font-lock-variable-name-face))))
+(defcustom elisp-eldoc-show-function-docstring nil
+  "Show function docstring in `eldoc-mode'.
+If set to `short' only display a short docstring, otherwise if set to
+`full', display full docstring.
+
+If set to nil do not show function docstring."
+  :type '(choice
+          (const :tag "None")
+          (const :tag "Short" short)
+          (const :tag "Full" full))
+  :group 'elisp)
 
 (defun elisp-get-fnsym-args-string (sym &optional index)
   "Return a string containing the parameter list of the function SYM.
@@ -1908,8 +1919,17 @@ elisp-get-fnsym-args-string
 		     (substitute-command-keys (car doc)))
 		    (t (help-function-arglist sym)))))
              ;; Stringify, and store before highlighting, downcasing, etc.
-	     (elisp--last-data-store sym (elisp-function-argstring args)
-                                     'function))))))
+	     (elisp--last-data-store
+              sym
+              (concat (elisp-function-argstring args)
+                      (pcase elisp-eldoc-show-function-docstring
+                        ('full
+                         (concat "\n" (cdr doc)))
+                        ('short
+                         (save-match-data
+                           (when (string-match "\\." (cdr doc))
+                             (concat "\n" (substring (cdr doc) 0 (match-end 0))))))))
+              'function))))))
     ;; Highlight
     (if argstring
 	(elisp--highlight-function-argument
-- 
2.48.1


--=-=-=
Content-Type: text/plain


-- 
                                          - E.G via GNU Emacs and Org.

--=-=-=--

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Elijah Gabe =?UTF-8?Q?P=C3=A9rez?= <eg642616@HIDDEN>
Subject: bug#77124: Acknowledgement ([PATCH] Optionally display function
 docstring in eldoc)
Message-ID: <handler.77124.B.17424091666775.ack <at> debbugs.gnu.org>
References: <871pus50sw.fsf@HIDDEN>
X-Gnu-PR-Message: ack 77124
X-Gnu-PR-Package: emacs
X-Gnu-PR-Keywords: patch
Reply-To: 77124 <at> debbugs.gnu.org
Date: Wed, 19 Mar 2025 18:33:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 77124 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
77124: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D77124
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message received at control <at> debbugs.gnu.org:

Received: (at control) by debbugs.gnu.org; 19 Mar 2025 20:54:48 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Wed Mar 19 16:54:48 2025
Received: from localhost ([127.0.0.1]:53413 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1tv0R6-0003PQ-3e
	for submit <at> debbugs.gnu.org; Wed, 19 Mar 2025 16:54:48 -0400
Received: from mail-ed1-x531.google.com ([2a00:1450:4864:20::531]:42481)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>)
 id 1tv0R2-0003P2-2n
 for control <at> debbugs.gnu.org; Wed, 19 Mar 2025 16:54:44 -0400
Received: by mail-ed1-x531.google.com with SMTP id
 4fb4d7f45d1cf-5e614da8615so166495a12.1
 for <control <at> debbugs.gnu.org>; Wed, 19 Mar 2025 13:54:44 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20230601; t=1742417678; x=1743022478; darn=debbugs.gnu.org;
 h=to:subject:message-id:date:mime-version:from:from:to:cc:subject
 :date:message-id:reply-to;
 bh=rsPECPhBF9ikGz3o8JNM4KghZSvGybzyETNna6qKICw=;
 b=EQ7BfNWf5qxCV2PXEFTvT+GzKsfB3ahTEOo06Zk+rAp0DUZCxPuZKY4CidUWmKJr00
 FNYO3KKrnUF5hUPwSypXkQS0sNQ9uiIR7IakQkAt+nAKObLTKQOv8Zu+geQLeanz7/Wb
 jLrbyxxmEt88bZzpdzcE0kBSvIUqG6YauUWdQ0E/vYIE5cYhGOO1FfouPtc24RHojU+9
 rNTY1p/0s1s2dIg99W8/0siX1NgyHvkXStezeEvr3YQjxDJhvGjq4EkFE0ib4nyNjZ1a
 EoV0l/naHewp3H/nvchNTW6GLwGtFFrxhGHK271vJ2JVDMkJiZWhB8CgpJ6DEqNXV0jY
 8zDw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1742417678; x=1743022478;
 h=to:subject:message-id:date:mime-version:from:x-gm-message-state
 :from:to:cc:subject:date:message-id:reply-to;
 bh=rsPECPhBF9ikGz3o8JNM4KghZSvGybzyETNna6qKICw=;
 b=cS/AleiaYqMxmjgumesSNdUJJ13UhWJFBIMaLwJ8U3DxB0eitwVduCkur9lbKIMMQ0
 26IkXYeH0R5EYrqxQ0zRV/djxEWe8yBrfMPjZBmkOfUUZGEqkrwUTxLndAFanMw5jVB8
 FKzaEVKEvsHFnfJLDHGgpK6w1ZMdhg6Llu/YDb2tAK3/CIlbCzBjJwXYmGRw9v28+T3e
 M8MiPRqBOXl3Q0/W+aaX+lIkfpTZX+6jZtASZcILIFdpmi5aStt+ayoL8L3obJIVO0zS
 jagYLhg0BacWI+MfZSv5q+cWTacdp8Dnw9nPJpGpc8KUQJfSuvjSc11x/SpIIuXXiNPl
 z1/g==
X-Gm-Message-State: AOJu0YzNevQYJSBcq6QTTRNLrAjXpCVMHesdJVSVkzFWYk30yN0lVmyV
 6Cjfzj17DXU1NWIxT6EmtC51xVWmD802IPXxgJtK09HVoL/3CZy6VYUhpFvyC4wKTrF8S/TuCAm
 T8bsgAnLdFG002xDXwmgOYxWYRHL7s1XV
X-Gm-Gg: ASbGncvAmkG7T84sgqHgv1+Clc16nV9x8S+IlUvfojxoXsiCOhNCI8rt9Aiq7dQvB4J
 uWUCyl3Zm0Xu4kRl2xlrd4s8J2sR0vlvpzHNblMCteW4rA6Bc96CUz+Y9Uv+D/m6f+FG/tPUHfZ
 M1UnE1GYgcsaA3WlEaEylYgoKJpVw=
X-Google-Smtp-Source: AGHT+IHzQ4kAfcNvAUHZjmrg4o4N/xBjwxlsSndSNayDQlucqUD4wPvBB3b/aCtG+lLMupFZbcPWZnnm++5UR5ctQ4o=
X-Received: by 2002:a05:6402:358f:b0:5de:d932:a54c with SMTP id
 4fb4d7f45d1cf-5eb996fe439mr1242265a12.2.1742417677784; Wed, 19 Mar 2025
 13:54:37 -0700 (PDT)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Wed, 19 Mar 2025 13:54:37 -0700
From: Stefan Kangas <stefankangas@HIDDEN>
MIME-Version: 1.0
Date: Wed, 19 Mar 2025 13:54:37 -0700
X-Gm-Features: AQ5f1Jr8E0Gt6pg2YG_DP3YJfAnZm6GE2a_3Ia4xEL4sMZr4CaoYnBimYD_U5co
Message-ID: <CADwFkm=RWOYD77NbR=8i8U23BACVRZ07-AyPUuLw9js7k8iGog@HIDDEN>
Subject: control message for bug #77124
To: control <at> debbugs.gnu.org
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: control
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

severity 77124 wishlist
quit

Last modified: Wed, 19 Mar 2025 21:00:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.