From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Newsgroups: gmane.emacs.bugs Subject: bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages Date: Fri, 4 Sep 2020 19:32:30 +0100 Message-ID: References: Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="00000000000033107c05ae81181a" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="21840"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 43205@debbugs.gnu.org To: Yuan Fu Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Sep 04 20:33:11 2020 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 1kEGWM-0005a2-KU for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 04 Sep 2020 20:33:10 +0200 Original-Received: from localhost ([::1]:39146 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kEGWL-000553-Lv for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 04 Sep 2020 14:33:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34122) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kEGWE-000533-3A for bug-gnu-emacs@gnu.org; Fri, 04 Sep 2020 14:33:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:57291) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kEGWD-0004rc-QS for bug-gnu-emacs@gnu.org; Fri, 04 Sep 2020 14:33:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kEGWD-0005Vt-MN for bug-gnu-emacs@gnu.org; Fri, 04 Sep 2020 14:33:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 04 Sep 2020 18:33:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 43205 X-GNU-PR-Package: emacs Original-Received: via spool by 43205-submit@debbugs.gnu.org id=B43205.159924437121177 (code B ref 43205); Fri, 04 Sep 2020 18:33:01 +0000 Original-Received: (at 43205) by debbugs.gnu.org; 4 Sep 2020 18:32:51 +0000 Original-Received: from localhost ([127.0.0.1]:40604 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kEGW3-0005VV-Cb for submit@debbugs.gnu.org; Fri, 04 Sep 2020 14:32:51 -0400 Original-Received: from mail-io1-f51.google.com ([209.85.166.51]:33463) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kEGW1-0005VH-8G for 43205@debbugs.gnu.org; Fri, 04 Sep 2020 14:32:49 -0400 Original-Received: by mail-io1-f51.google.com with SMTP id g14so8154315iom.0 for <43205@debbugs.gnu.org>; Fri, 04 Sep 2020 11:32:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=oziOXqD6xHgXFAi04AFRljiZAveeG5CF0Tg7bwKo2Ek=; b=XdnOsPsak5qMQskEsu7uPUYlKOenMK9mXWiAGqjGXeATRyVExG6GrLn1lJ/dPBvSx9 4r38IN7qE9rnwPeMJ/FXBNsnxlQZYbS6WCWKaT9lBnYRFYUB3qeYL7g03N5DOuQrwelk odTCCP4SIhjiedfy/zHWV8WBv3YqfRicUzkAT+OuWZYm3/VmWMCVqdcYwye4kaMJhJWV o4mPU6hZbjy4HEmtftLTLkKk+d0xMnevYKjAZsrDA2/hl17bxHe/4gnLwUJsvbQSj8W7 TeJ16PFmfMYJDoY/xYY3WFxPXk4tMLSv7fzUdYwBdPgTlcEXtJv0gOBgNovpxF39Qzoc kWdA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=oziOXqD6xHgXFAi04AFRljiZAveeG5CF0Tg7bwKo2Ek=; b=kte7ym3McPC2+sZJ0aBXpnHmwlnQ69auq3A2IEu+ehrdf0ddYfiu4+SOkCz10Oh4K2 QjECykRHR5TYbSv1Xh82c8+e9weRTKR0GLMdqfCUWZwHOURZPXjb9QV2h+28aX30/fSh qwtILXaGeHZtDjVDXBjT064DOLsREs4+SLptfLjmZA2RsasDzfFnE+gyGn5QJVSbKcTd vxhnmYytQ06AVRywmuDhs6Ccd4on7wh+RjT2dbQoZ5DEZSEsxak1Qxku0IZkzTZnDcCq ZwkRorS2SiJpuyDwG79Ln78GaYt+XwqC6FupxDC6OeFKcoxFtuX2gqPlth59WwS06cZs lvSA== X-Gm-Message-State: AOAM532/BFXNg9ttwPtbhCsKAwaXWMwsQoKkDRqxv8sSMSicQnXnmCsI /zjz57W/FGzg2gWHB4Y+0G6+WCca7iSgRUukJ6Q= X-Google-Smtp-Source: ABdhPJzOcGXiLNVSycsJMorkGcEmw7CRWX6V3r9w3OAXFw+rRno3AwlWw8hMtnlEYAKY5LZbL/tLraA9PX9MPHjCcM4= X-Received: by 2002:a5d:968f:: with SMTP id m15mr8928625ion.156.1599244363566; Fri, 04 Sep 2020 11:32:43 -0700 (PDT) In-Reply-To: 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" Xref: news.gmane.io gmane.emacs.bugs:187162 Archived-At: --00000000000033107c05ae81181a Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Acknowledged. The latest eldoc in master is a work in progress.This in on my to-do list. Soon I'll improve the documentation, as well as specifying what the "display engine" is supposed to be. I think, this will be quite useful when (re) designing your eldoc-box extension, Yuan. Maybe that extension could even be included into Emacs itself. Jo=C3=A3o On Fri, Sep 4, 2020, 17:18 Yuan Fu wrote: > Currently the documentation of `eldoc-documentation-functions' says this: > > * `:thing', VALUE is a short string or symbol designating what is > being reported on. The documentation display engine can elect > to remove this information depending on space contraints; > > without saying what VALUE could be. For someone who want to write a > frontend to display eldoc signitures, this is useless. For someone who > want to write a documentation backend for eldoc, this is useless as > well. I think the protocol should at least specify what VALUE could be > expected: signature? full-doc? example? links? > > > > Also contraints is spelled wrong. And on line 705. > > > > --00000000000033107c05ae81181a Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Acknowledged. The latest eldoc in master is a work in pro= gress.This in on my to-do list. Soon I'll improve the documentation, as= well as specifying what the "display engine" is supposed to be.<= div dir=3D"auto">
I think, this will be quite us= eful when (re) designing your eldoc-box extension, Yuan. Maybe that extensi= on could even be included into Emacs itself.

Jo=C3=A3o

On Fri, Sep 4, 2020, 17:18 Yuan Fu <= casouri@gmail.com> wrote:
Currently the documentation of `eldoc-do= cumentation-functions' says this:

* `:thing', VALUE is a short string or symbol designating what is
being reported on.=C2=A0 The documentation display engine can elect
to remove this information depending on space contraints;

without saying what VALUE could be. For someone who want to write a
frontend to display eldoc signitures, this is useless. For someone who
want to write a documentation backend for eldoc, this is useless as
well. I think the protocol should at least specify what VALUE could be
expected: signature? full-doc? example? links?



Also contraints is spelled wrong. And on line 705.



--00000000000033107c05ae81181a--