Formatting of hover tooltips is off in VSCode about mesonlsp HOT 7 OPEN

I think that the way clangd formats things is more readable:

I think the way that Pylance shows optional parameters is pretty good.

from mesonlsp.

How would you expect it to get formatted?

The format is currently:

<function_name>

<function_docs>

required positional arguments
optional positional arguments
required kwargs
optional kwargs

The optional args are surrounded with []

from mesonlsp.

My opinions are subjective though.

from mesonlsp.

What do you think of this?

I've reordered the fields and improved the formatting. But I really want the documentation to be the first line after the identifier

from mesonlsp.

Does Meson not document what the defaults are for optional kwargs? I still think that the bracketed optionals aren't very intuitive. Perhaps using allow_fallback: bool = ... would be better. I think monospacing the return type would be good too.

The one thing I notice on the Pylance screenshot is that the documentation seems to be on another section of the tooltip. What you have is fine.

from mesonlsp.

Does Meson not document what the defaults are for optional kwargs?

Yes. It requires again copy-pasting from the docs. For the long run, it would be cool, if even the modules would have everything in that yaml file meson can generate as it could drop a lot of code here. (Or make it autogenerated) I've applied your other suggestions

from mesonlsp.

Yes

We definitely need to change this.

from mesonlsp.