all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "T.V Raman" <raman@google.com>
To: joaotavora@gmail.com
Cc: raman@google.com, emacs-devel@gnu.org
Subject: Re: Need help with eldoc:
Date: Thu, 24 Mar 2022 16:39:00 -0700	[thread overview]
Message-ID: <25149.276.56904.499053@retriever.mtv.corp.google.com> (raw)
In-Reply-To: <CALDnm50KK7cN2swmeLC_NSRF0YS0-ekj92gGzXSNspNqm_DsgQ@mail.gmail.com>


thanks for reaching out and replying!

So let me step back and explain what I want and I'm sure you'll know
the answer.

I use and maintain emacspeak (https://emacspeak.sf.net --- code is on
github under https://github.com/tvraman/emacspeak

Eldoc is extremely useful to the blind software engineer, perhaps even
more so than to someone who can glance at the docs in another
window. But eldoc spopping up and speaking based on an idel timer is
suboptimal.

So what I had implemented a few years ago was:

1. Turn off global eldoc mode.

   2. Advice the eldoc-message machinery to cache the displayed
      message somewhre
      3. Added an interactive command that spoke that cached value

         Result: a blind user could avoid the constant interruption
         from eldoc but ask for the documentation when needed with a
         single keystroke.

         Your explanation around how async updates works now explains
         my older solution broke, and   I was naively trying to call
         what seemed to the closest equivalent which was clearly
         wrong.

         So to cut to the chase; could you provide me a simple
         mechanism that I could call from emacspeak (via a keybinding
         bound to an interactive command I write) where that command
         calls into the eldoc machinery and gets back the help that
         eldoc displays?

         

João Távora writes:
 > >
 > > Could the current maintainer of eldoc give some pointers on what might
 > >    be breaking?
 > >
 > 
 > Hello Raman,
 > 
 > I'm not formally the maintainer of Eldoc (I think) but I have worked on it
 > recently (read more than one year ago).  The changes I introduced make it
 > so that the documentation-generating functions in
 > eldoc-documentation-functions
 > (plural!) can now be asynchronous (i.e. not return doc results immediately).
 > 
 > eldoc-documentation-default should not be called directly from elisp
 > libraries other
 > than eldoc.el itself, which handles this possible asynchronicity.  It is a
 > function value to
 > be put into eldoc-documentation-function which is then called by the
 > eldoc.el machinery
 > (such as M-x eldoc) that gives it context.
 > 
 > So can you tell me what are you trying to accomplish?  Maybe I can help.
 > 
 > João

-- 

Thanks,

--Raman(I Search, I Find, I Misplace, I Research)
♉ Id: kg:/m/0285kf1  🦮

--

Thanks,

--Raman(I Search, I Find, I Misplace, I Research)
♉ Id: kg:/m/0285kf1  🦮



  reply	other threads:[~2022-03-24 23:39 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-24 14:21 Need help with eldoc: T.V Raman
2022-03-24 23:28 ` João Távora
2022-03-24 23:39   ` T.V Raman [this message]
2022-03-25  0:16     ` João Távora
2022-03-25  2:21       ` T.V Raman
2022-03-25 10:03         ` João Távora
2022-03-25 14:03           ` T.V Raman
2022-03-25 22:52             ` João Távora
2022-03-25 14:27       ` T.V Raman

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=25149.276.56904.499053@retriever.mtv.corp.google.com \
    --to=raman@google.com \
    --cc=emacs-devel@gnu.org \
    --cc=joaotavora@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.