Eldoc mode

Eldoc mode

[Richard M. Stallman]

man/programs.texi says:

      Eldoc mode applies
    in Emacs Lisp and Lisp Interaction modes, and perhaps a few others
    that provide special support for looking up doc strings.

Could someone please check the actual list of supported major modes?

Re: Eldoc mode

[Masatake YAMATO]

> man/programs.texi says:
> 
>       Eldoc mode applies
>     in Emacs Lisp and Lisp Interaction modes, and perhaps a few others
>     that provide special support for looking up doc strings.
> 
> Could someone please check the actual list of supported major modes?

hexl-mode, python-mode and eshell-mode are supported.

Re: Eldoc mode

[Stefan Monnier]

>> man/programs.texi says:
>> 
>> Eldoc mode applies
>> in Emacs Lisp and Lisp Interaction modes, and perhaps a few others
>> that provide special support for looking up doc strings.
>> 
>> Could someone please check the actual list of supported major modes?

> hexl-mode, python-mode and eshell-mode are supported.

Haskell-mode as well (tho it's not distributed with Emacs).


        Stefan

Re: Eldoc mode

[Richard M. Stallman]

What does Eldoc do in Hexl mode?  I can't imagine.

What does Eldoc do in Eshell?  Does it give documentation
on shell commands?  If so, could it easily work in sh-script mode
and in the Shell buffer too?

Re: Eldoc mode

[Masatake YAMATO]

> What does Eldoc do in Hexl mode?  I can't imagine.

Eldoc shows the address specified by point in hexadecimal and
decimal format.

> What does Eldoc do in Eshell?  Does it give documentation
> on shell commands?  If so, could it easily work in sh-script mode
> and in the Shell buffer too?

I don't know well about this. Maybe it gives documentation on elisp
command. Eldoc on ielm does the same thing.

Masatake YAMATO

Re: Eldoc mode

[Richard M. Stallman]

    > What does Eldoc do in Eshell?  Does it give documentation
    > on shell commands?  If so, could it easily work in sh-script mode
    > and in the Shell buffer too?

    I don't know well about this. Maybe it gives documentation on elisp
    command.

Eshell implements a shell within Emacs.
Its commands seem to be shell commands, not Emacs Lisp.

Re: Eldoc mode

[Masatake YAMATO]

>     > What does Eldoc do in Eshell?  Does it give documentation
>     > on shell commands?  If so, could it easily work in sh-script mode
>     > and in the Shell buffer too?
> 
>     I don't know well about this. Maybe it gives documentation on elisp
>     command.
> 
> Eshell implements a shell within Emacs.

Yes.

> Its commands seem to be shell commands, not Emacs Lisp.

No. I don't use eshell. However, AFAIK, Eshell accepts both
shell command line and Emacs lisp code. Here is the example:

----------------------------------------------------------------------------------------
    Welcome to the Emacs shell

    ~/Mail/inbox $ cd /tmp
    /tmp $ ls
    9Komc1                                                         index.sjis.txt
    E                                                              jet11338agW
    E1                                                             jet15672diB
    ...
    /tmp $ (car (list 1 2 3))
    1
    /tmp $ 
----------------------------------------------------------------------------------------

Re: Eldoc mode

[Richard M. Stallman]

    No. I don't use eshell. However, AFAIK, Eshell accepts both
    shell command line and Emacs lisp code. Here is the example:

I did not know that.  Could you possibly update the doc string of
eshell?

Anyway, that clears up the question of what Eldoc mode does
in Eshell.

Re: Eldoc mode

[Masatake YAMATO]

>     No. I don't use eshell. However, AFAIK, Eshell accepts both
>     shell command line and Emacs lisp code. Here is the example:
> 
> I did not know that.  Could you possibly update the doc string of
> eshell?
> 
> Anyway, that clears up the question of what Eldoc mode does
> in Eshell.

I've look at the Eshell's code. Then I found that Eshell uses
Eldoc only for getting the document string of a function. Eshell
doesn't use Eldoc for displaying documentation in real time.
So there is nothing to add to the document string.

If what I wrote here is not clear enough, do
M-x find-function eshell-exec-lisp
It may be obvious.

Masatake YAMATO