Improve Documentation Comment Support

[NonRidiculousAdjective]

Zed 1.19.2 
Commit: df181c6f58d02677b385fa947d6bfde6d3530078
Version: 1.19.2+stable.356.df181c6f58d02677b385fa947d6bfde6d3530078

Hi there,

thanks a lot for the extension! Would it be possible to improve support for documentation comments? As in they would behave as described in docs:
https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_documentation_comments.html

The bbcode and highlights are done very well in the native editor and it's a shame that they don't carry over to zed the same.
I am providing an example below:

Native

Zed

[NathanLovato]

Ah shoot, I had fixed it for a previous version of Godot/zed, and it seems that the line/paragraph wrapping regressed.

This will likely need changes to Godot as we cannot control and clean up the markup from within zed. What happens in Godot's language server is that the BBCode gets converted to markdown, which is the format that code editors like VSCode or Zed expect.

We can only convert in one way for all editors but actually different code editors don't read and process markdown consistently. You have to find the sweet spot +/- through trial and error.

[NonRidiculousAdjective]

I see, thanks for the swift reply!

[NathanLovato]

You can leave this open for now, just for tracking the issue because it probably happens only with zed. In the Godot issue tracker it will get drowned. May I just ask which version of Godot you are using?

[HolonProduction]

It's VSC as well: godotengine/godot-vscode-plugin#1055

[NathanLovato]

Thanks for letting me know as always. It's kind of the limit of the approach in the Godot source code with string replace as opposed to proper parsing. But as this seems to be an edge case, perhaps when encountering a[br] tag, we can do a lookahead to consume any number of BR tags optionally separated by whitespace to create a paragraph break. that should do the trick for this

[HolonProduction]

Yeah will need to touch up the conversion before 4.8 anyway since some new tags were added. Will see if I can sneak a workaround in.