Subject: Re: bug#71720: [PATCH] Do not prematurely truncate python eldoc string

From: James Thomas <[email-masked]>
Date: Sun, 23 Jun 2024 08:32:19 +0530

kobarity wrote:

> James Thomas wrote:
>> Eli Zaretskii wrote:
>>
>> >> Date: Sat, 22 Jun 2024 23:16:51 +0900
>> >> From: kobarity <[email-masked]>
>> >> Cc: [email-masked]
>> >>
>> >> Eli Zaretskii wrote:
>> >> >
>> >> > kobarity, any comments?
>> >>
>> >> I agree with this fix.  For those who want the same behavior as
>> >> before, setting eldoc-echo-area-use-multiline-p to nil should be
>> >> sufficient.  It might be better to make this change known in etc/NEWS,
>> >> though.
>> >
>> > Thanks.
>> >
>> > James, can you add a NEWS entry and resubmit?
>>
>> How about this?
>
>> +*** 'eldoc' no longer truncates to a single line by default.
>> +Previously, the entire docstring was not available to eldoc, which made
>> +'eldoc-echo-area-use-multiline-p' ineffective. The old behaviour may be
>> +kept by setting that.
>> +
>
> Thanks, I think the content is perfect, but from other examples, it
> might be better to have two spaces after the period.

Fixed:

From f91a94aca5119ebde21e24392b0d46d44dd9e078 Mon Sep 17 00:00:00 2001
From: James Thomas <[email-masked]>
Date: Sat, 22 Jun 2024 17:57:00 +0530
Subject: [PATCH] Do not prematurely truncate python eldoc string

'eldoc-echo-area-use-multiline-p' is there for that.
* lisp/progmodes/python.el (python-eldoc-setup-code):
Make the change.
---
 etc/NEWS                 | 5 +++++
 lisp/progmodes/python.el | 2 --
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 2349cc0cacb..201ef46bac5 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1499,6 +1499,11 @@ interactive Python interpreter specified by 'python-interpreter'.
 It sends the python block delimited by 'python-nav-beginning-of-block'
 and 'python-nav-end-of-block' to the inferior Python process.

+*** 'eldoc' no longer truncates to a single line by default.
+Previously, the entire docstring was not available to eldoc, which made
+'eldoc-echo-area-use-multiline-p' ineffective.  The old behaviour may be
+kept by setting that.
+
 ** Inferior Python mode

 ---
diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
index bb2bf1731b4..a52e21f625e 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -5607,8 +5607,6 @@ python-eldoc-setup-code
                 doc = '{objtype} {name}{args}'.format(
                     objtype=objtype, name=name, args=args
                 )
-        else:
-            doc = doc.splitlines()[0]
     except:
         doc = ''
     return doc"
--
2.43.0

--