emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: "James N. V. Cash" <james.nvc@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Make org-eldoc work with Emacs 28
Date: Thu, 16 Jul 2020 02:20:01 +0100	[thread overview]
Message-ID: <87o8ogntmm.fsf@tcd.ie> (raw)
In-Reply-To: <878sfrnxvp.fsf@gmail.com> (James N. V. Cash's message of "Fri, 10 Jul 2020 12:22:18 -0400")

"James N. V. Cash" <james.nvc@gmail.com> writes:

> This patch makes it continue to work by setting the new variable
> eldoc-documentation-strategy, which puts eldoc in
> "backwards-compatability" mode.

How involved would it be to make org-eldoc work in
non-"backwards-compatibility" mode?

> From 5c04048c0d1ed3f80c7dd3e6477e12fc8e760675 Mon Sep 17 00:00:00 2001
> From: "James N. V. Cash" <james.nvc@gmail.com>
> Date: Fri, 10 Jul 2020 11:56:23 -0400
> Subject: [PATCH] Make org-eldoc work with Emacs 28's new eldoc API
>
> Still using backward-compatability to use the old style of
> function. The new way is to make the documentation function take a
> callback, but this approach means the fewest changes.
> ---
>  contrib/lisp/org-eldoc.el | 14 +++++++++-----
>  1 file changed, 9 insertions(+), 5 deletions(-)
>
> diff --git a/contrib/lisp/org-eldoc.el b/contrib/lisp/org-eldoc.el
> index 72b10a1fb..060674b24 100644
> --- a/contrib/lisp/org-eldoc.el
> +++ b/contrib/lisp/org-eldoc.el
> @@ -161,11 +161,15 @@
>  (defun org-eldoc-load ()
>    "Set up org-eldoc documentation function."
>    (interactive)
> -  (if (boundp 'eldoc-documentation-functions)
> -      (add-hook 'eldoc-documentation-functions
> -		#'org-eldoc-documentation-function nil t)
> -    (setq-local eldoc-documentation-function
> -		#'org-eldoc-documentation-function)))
> +  (cond
> +   ((boundp 'eldoc-documentation-strategy)
> +    (setq-local eldoc-documentation-strategy
> +		#'org-eldoc-documentation-function))
> +   ((boundp 'eldoc-documentation-functions)
> +    (add-hook 'eldoc-documentation-functions
> +	      #'org-eldoc-documentation-function nil t))

Both eldoc-documentation-strategy and eldoc-documentation-functions are
new in Emacs 28, so if one is defined, then so is the other.

More importantly, functions added to eldoc-documentation-functions must
take at least one argument, so org-eldoc-documentation-function is not a
suitable function in its current state.

> +   (t (setq-local eldoc-documentation-function
> +		  #'org-eldoc-documentation-function))))

Thanks,

-- 
Basil

next prev parent reply	other threads:[~2020-07-16  1:20 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-10 16:22 [PATCH] Make org-eldoc work with Emacs 28 James N. V. Cash
2020-07-13 16:23 ` Nicolas Goaziou
     [not found]   ` <87zh83l66q.fsf@gmail.com>
2020-07-13 16:41     ` James N. V. Cash
2020-07-16  1:20 ` Basil L. Contovounesios [this message]
2020-07-16  4:29   ` Kyle Meyer
2020-07-16 14:34     ` James N. V. Cash
2020-07-17  5:41       ` [PATCH] org-eldoc: Fix compatibility " Kyle Meyer
2020-07-17 10:12         ` Basil L. Contovounesios
2020-07-17 16:13           ` Eric Abrahamsen
2020-07-17 22:11           ` Kyle Meyer
2020-07-17 11:24         ` Joseph Mingrone
2020-07-19  0:20           ` Kyle Meyer

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

  List information: https://www.orgmode.org/

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

  git send-email \
    --in-reply-to=87o8ogntmm.fsf@tcd.ie \
    --to=contovob@tcd.ie \
    --cc=emacs-orgmode@gnu.org \
    --cc=james.nvc@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

Code repositories for project(s) associated with this public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).