GNU logs - #77628, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#77628: [PATCH] ; Fix `elisp-eldoc-funcall-with-docstring' when fn has no docstring.
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: Tue, 08 Apr 2025 05:08:02 +0000
Resent-Message-ID: <handler.77628.B.174408882623103 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 77628 <at> debbugs.gnu.org
From: Elijah Gabe =?UTF-8?Q?P=C3=A9rez?= <eg642616@HIDDEN>
Date: Mon, 07 Apr 2025 23:06:45 -0600
Message-ID: <877c3vxmvu.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
Received-SPF: pass client-ip=2607:f8b0:4864:20::c43;
 envelope-from=eg642616@HIDDEN; helo=mail-oo1-xc43.google.com
X-Spam_score_int: -17
X-Spam_score: -1.8
X-Spam_bar: -
X-Spam_report: (-1.8 / 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, 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 patch makes
 `elisp-eldoc-funcall-with-docstring'
 handle functions without a docstring and limit docstring to 1000 characters.
 -- - E.G via GNU Emacs and Org. 
 Content analysis details:   (1.2 points, 10.0 required)
 pts rule name              description
 ---- ---------------------- --------------------------------------------------
 -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]
 -0.0 SPF_HELO_PASS          SPF: HELO matches SPF record
 0.2 FREEMAIL_ENVFROM_END_DIGIT Envelope-from freemail username ends
 in digit (eg642616[at]gmail.com)
 0.0 FREEMAIL_FROM          Sender email is commonly abused enduser mail
 provider (eg642616[at]gmail.com)
 1.0 SPF_SOFTFAIL           SPF: sender does not match SPF record (softfail)
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 (/)

Tags: patch

This patch makes `elisp-eldoc-funcall-with-docstring' handle functions
without a docstring and limit docstring to 1000 characters.

-- 
                                          - 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#77628: Acknowledgement ([PATCH] ; Fix `elisp-eldoc-funcall-with-docstring'
 when fn has no docstring.)
Message-ID: <handler.77628.B.174408882623103.ack <at> debbugs.gnu.org>
References: <877c3vxmvu.fsf@HIDDEN>
X-Gnu-PR-Message: ack 77628
X-Gnu-PR-Package: emacs
X-Gnu-PR-Keywords: patch
Reply-To: 77628 <at> debbugs.gnu.org
Date: Tue, 08 Apr 2025 05:08: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 77628 <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
77628: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D77628
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#77628: [PATCH] ; Fix `elisp-eldoc-funcall-with-docstring' when fn has no docstring.
References: <877c3vxmvu.fsf@HIDDEN>
In-Reply-To: <877c3vxmvu.fsf@HIDDEN>
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: Tue, 08 Apr 2025 05:09:02 +0000
Resent-Message-ID: <handler.77628.B77628.174408890923667 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 77628 <at> debbugs.gnu.org
From: Elijah Gabe =?UTF-8?Q?P=C3=A9rez?= <eg642616@HIDDEN>
Date: Mon, 07 Apr 2025 23:08:18 -0600
Message-ID: <874iyzxmt9.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

--=-=-=
Content-Type: text/patch
Content-Disposition: attachment;
 filename=0001-Fix-elisp-eldoc-funcall-with-docstring-when-fn-has-n.patch

From 0aefc44cd151725cceb755776c497b62746465cb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?El=C3=ADas=20Gabriel=20P=C3=A9rez?= <eg642616@HIDDEN>
Date: Mon, 7 Apr 2025 23:00:20 -0600
Subject: [PATCH] ; Fix `elisp-eldoc-funcall-with-docstring' when fn has no
 docstring.

* lisp/progmodes/elisp-mode.el (elisp-eldoc-funcall-with-docstring):
Add "Undocumented" as docstring if the function as no docstring,
and limit docstring length to 1000 characters.  (bug#)
---
 lisp/progmodes/elisp-mode.el | 29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)

diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el
index 748d2f11360..7b8f4af746b 100644
--- a/lisp/progmodes/elisp-mode.el
+++ b/lisp/progmodes/elisp-mode.el
@@ -1861,17 +1861,22 @@ elisp-eldoc-funcall-with-docstring
 Compared to `elisp-eldoc-funcall', this also includes the
 current function doc string, doc string length depends on
 `elisp-eldoc-funcall-with-docstring-length'."
-  (let* ((sym-info (elisp--fnsym-in-current-sexp))
-         (fn-sym (car sym-info))
-         (doc (when (fboundp fn-sym)
-                (propertize
-                 (cdr (help-split-fundoc
-                       (condition-case nil (documentation fn-sym t)
-                         (invalid-function nil))
-                       fn-sym))
-                 'face 'font-lock-doc-face))))
-    (when fn-sym
-      (funcall callback
+  (when-let* ((sym-info (elisp--fnsym-in-current-sexp))
+              (fn-sym (car sym-info))
+              (fn-doc (or (cdr (help-split-fundoc
+                                (condition-case nil (documentation fn-sym t)
+                                  (invalid-function nil))
+                                fn-sym))
+                          "Undocumented."))
+              (more (- (length fn-doc) 1000))
+              (doc (when (fboundp fn-sym)
+                     (concat
+                      (propertize
+                       (string-limit fn-doc 1000)
+                       'face 'font-lock-doc-face)
+                      (when (> more 0)
+                        (format "[%sc more]" more))))))
+    (funcall callback
                (concat (apply #'elisp-get-fnsym-args-string sym-info)
                        ;; Ensure not display the docstring in the
                        ;; mode-line.
@@ -1887,7 +1892,7 @@ elisp-eldoc-funcall-with-docstring
                :thing fn-sym
                :face (if (functionp fn-sym)
                          'font-lock-function-name-face
-                       'font-lock-keyword-face)))))
+                       'font-lock-keyword-face))))
 
 (defun elisp-eldoc-var-docstring (callback &rest _ignored)
   "Document variable at point by calling CALLBACK.
-- 
2.49.0


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

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

--=-=-=--

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#77628: [PATCH] ; Fix `elisp-eldoc-funcall-with-docstring' when fn has no docstring.
Resent-From: Eli Zaretskii <eliz@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 12 Apr 2025 11:18:02 +0000
Resent-Message-ID: <handler.77628.B77628.174445667214290 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Elijah Gabe =?UTF-8?Q?P=C3=A9rez?= <eg642616@HIDDEN>
Cc: 77628 <at> debbugs.gnu.org
Date: Sat, 12 Apr 2025 14:17:42 +0300
Message-Id: <86fridmxwp.fsf@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
In-Reply-To: <874iyzxmt9.fsf@HIDDEN> (message from Elijah Gabe
 =?UTF-8?Q?P=C3=A9rez?= on Mon, 07 Apr 2025 23:08:18 -0600)
References: <877c3vxmvu.fsf@HIDDEN> <874iyzxmt9.fsf@HIDDEN>
MIME-version: 1.0
Content-type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

> From: Elijah Gabe Pérez <eg642616@HIDDEN>
> Date: Mon, 07 Apr 2025 23:08:18 -0600
> 
> * lisp/progmodes/elisp-mode.el (elisp-eldoc-funcall-with-docstring):
> Add "Undocumented" as docstring if the function as no docstring,
> and limit docstring length to 1000 characters.  (bug#)

Thanks, but should 1000 be hard-coded, or should we perhaps have a
variable for it?

Last modified: Sat, 12 Apr 2025 11:30:02 UTC

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