all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Tomas Nordin <tomasn@posteo.net>
To: "João Távora" <joaotavora@gmail.com>
Cc: Steven De Herdt <steven.deherdt@gmail.com>, 45348@debbugs.gnu.org
Subject: bug#45348: 27.1; python-eldoc-setup-code uses obsolete python function
Date: Mon, 28 Dec 2020 17:19:38 +0100	[thread overview]
Message-ID: <87zh1x6gyt.fsf@posteo.net> (raw)
In-Reply-To: <CALDnm51=9FqchWM2hMKPtmgacw1dOk=-0_PueopYfVnc5BjMFQ@mail.gmail.com>

João Távora <joaotavora@gmail.com> writes:

> On Wed, Dec 23, 2020, 23:54 Tomas Nordin <tomasn@posteo.net> wrote:
>
>>
>> Meaning, if there is a docstring, we will not get the call signature,
>> we get that only when there is no docstring. Personally I would prefer
>> the call signature always, like in elisp. Then perhaps when doing C-c
>> C-f (python-eldoc-at-point) show the (full) docstring. But that would be
>> another bug-report I guess.
>>
>
> If you think you can program this, the latest ElDoc allows you to do just
> that. See the docstrings of eldoc-documentation-functions,
> eldoc-documentation-strategy, eldoc-display-functions and other variables
> prefixed eldoc-echo-area. Also see the new interactive command M-x eldoc.
>
> All of those things have been touched recently by me, and I'd appreciate
> the feedback.

OK, thanks. Then we know the API to read up on when it comes to that.

I would be happy to try and help improving the doc support in python.el.
The strategy I would suggest to do that would be

-- C-c C-d         python-describe-at-point

Make this display full documentation akin to C-h f in elisp. Document
this function to do so, currently it is un-documented. And current
effect is to leave the help text in the python shell, which works
sometimes.

-- C-c C-f         python-eldoc-at-point

Make this output the first line of docstring, if there is no docstring
show nothing. This is almost what happens now, only if there is no
docstring the signature is given instead.

-- Automatic help display of objects

Make this show signatures always. (akin to elisp mode).

But I don't know if anybody care to see this happen.

Best regards
--
Tomas





  reply	other threads:[~2020-12-28 16:19 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-20 23:20 bug#45348: 27.1; python-eldoc-setup-code uses obsolete python function Steven De Herdt
2020-12-23 23:53 ` Tomas Nordin
2020-12-25 21:41   ` João Távora
2020-12-28 16:19     ` Tomas Nordin [this message]
2020-12-28 23:58       ` João Távora

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87zh1x6gyt.fsf@posteo.net \
    --to=tomasn@posteo.net \
    --cc=45348@debbugs.gnu.org \
    --cc=joaotavora@gmail.com \
    --cc=steven.deherdt@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.