How to keep the arity on the first line for every Clojure fn?

[zikajk]

EDIT:The original question was 'How to get eldoc-documentation-strategy right' but it was my wrong assumption about the problem....

Hi, I am using Eglot and Emacs@28 (MacPort).

1. When i move cursor on some code, I often get combination of eglot-hover-eldoc-function + eglot-signature-eldoc-function in eldoc buffer.

2. I suppose it is because Eglot changes eldoc-documentation-strategy to eldoc-documentation-compose.

3. What can I do about it? I tried a lot of things, but I am not able to get only one documentation for every symbol.

[joaotavora]

You can use eglot-managed-mode-hook to do adjustments to eldoc-documentation-functions, perhaps removing eldoc-hover-eldoc-function, but then you'll lose it in M-x eldoc output as well.

Now to your questions

1. Yes, that's what's supposed to work., But as I wrote above you can adjust it.
2. Yes, but this makes sense for Eglot generally. But you can also tweak that.
3. I don't know what you mean. It would seem you want the echo area to not popup hysterically with long hover information. You can use eglot-echo-area-use-multiline-p and set it to 1 or 2.

This is a pain point that I am working on for the next Eglot version. The only strategy that really makes sense is eldoc-documentation-compose but eldoc.el has learn to evolve to not allow enormous documentation to make it into the echo area outlet, (which is only one of its outlets -- see eldoc-display-functions), but is not suitable for very long multi-line strings.

[zikajk]

What i meant is to use only eglot-hover-eldoc-function or eglot-signature-eldoc-function but always use one of them
So if I update the picture, i would like to have hidden the first part as this

Because with some function, there is a lot of extra (duplicated) info.

[zikajk]

If I change eglot-echo-are-use-multiline-p then I don't get any information about input parameters...

I have a strong feeling that I didnt have this issue when i was using some old eglot version..

[joaotavora]

eglot-hover-eldoc-function or eglot-signature-eldoc-function but always use one of them

What if the two are available? Which one do you want to give priority to?

You must understand, I don't have this language server, and you haven't inequivocally clarified what function returns what.

Additionally, there seems to be some strange interference from your configuration. Are you using "doom" or something of the sort?

So in this example, what does eglot-hover-eldoc-function produce? And what does eglot-signature-eldoc-function produce?

If I change eglot-echo-are-use-multiline-p then I don't get any information about input parameters...

If you change it to what?

[zikajk]

When I remove eldoc-hover-eldoc-functionthen I don't get eldoc for some symbols that are missing eglot-signature-eldoc-function. So, i would remove it if I can have eglot-signature-eldoc-function for everything.
This is the case of defn in previous image - this is why I don't get input parameters in one line, defn is missing eglot-signature-eldoc-function..

[joaotavora]

Then don't remove eldoc-hover-eldoc-function, set eldoc-echo-area-use-multiple-p to 1 and perhaps eldoc-echo-area-display-truncation-message to nil.

[zikajk]

1. if two are available, I would like to give priority to eglot-signature-eldoc-function.
2. Sure, I'll be happy to add any details I can... The first part in that picture above is eglot-signature-eldoc-function and the second one is` eldoc-hover-eldoc-function'.
3. No, I am using vanilla Emacs
4. If i change it to nil, 1 or 2.

---

When I do this, then there is still the same issue...
This is ok:

This is not:

[joaotavora]

So I believe that LSP-Mode uses the second sexp as a signatures...

Rather, I think it is not inserting \n between the first two, is removing the \n in the second, and is inserting \n after the second as well (or killing the third entirely). ... lsp-mode has a lot of language specific code and Eglot has none. IMO that's what LSP should be about -- language-agnosticism of clients and editor-agnosticism of servers. But it means that I do something here it might break other servers, which is typical.

I'll read the spec closely to see it it says anything about this, but I think the correct thing to do is to ask Clojure-LSP people to issue a signature for defn, because that's what you're after. Anything else is a hack.

[zikajk]

I do agree. I have asked about this on Clojure-LSP Slack and I am going to keep it updated here.
For now, I am fine with default documentation-strategy, (setq eglot-echo-area-use-multiline-p nil) and with using eldoc-buffer when I need more info.

[zikajk]

If somebody has the same issue.. This is the current "workaround".

(with-eval-after-load 'eglot
       (add-to-list 'eglot-server-programs
                    '((clojure-mode clojurescript-mode clojurec-mode)
                      "clojure-lsp" :initializationOptions (:show-docs-arity-on-same-line? t))))

[joaotavora]

Good workaround. It does mean that, for some reason, clojure-lsp is returning signature info for some symbols as hover information. I wonder why they simply don't return that information which they already have in the signature.

If you have a link to the clojure-lsp conversation on github or somewhere else, please show it.

[zikajk]

Here it is. Obviously I'm having trouble explaining the problem :)
https://clojurians.slack.com/archives/CPABC1H61/p1678733411503889

[joaotavora]

This comment contains a good workaround: #1181 (reply in thread)

[zikajk]

Another solution is to use in.lsp/config.edn
{:hover {:arity-on-same-line? t}}

[joaotavora]

Neither of these are actually solutions.

I also think that soon, unfortunately, they will begin to fail. I'm thinking of making very long hover information stay out of the echo area. I'll make it customizable, so you can get back this behaviour, but my current thinking is that multi-line (say > 2) pieces of documentation do not belong in the Emacs echo area, they go to other eldoc outlets.

[zikajk]

I am using this with (setq eglot-echo-area-use-multiline-p nil), so I get only 1 line.