Irritating Markdown syntax for headings conflicts with traditional comment frames in Lua

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Annotations

Expected Behaviour

"Hello World!" in the following annotation is NOT treated as a heading:

--------------------------------------------------------------------------------
--- Hello World!
--------------------------------------------------------------------------------
local function Main() end

Actual Behaviour

"Hello World!" shows as a heading in the documentation pop-up window like so.

Reproduction steps

Type the following code and hover your mouse over the function name.

--------------------------------------------------------------------------------
--- Hello World!
--------------------------------------------------------------------------------
local function Main() end

Additional Notes

As someone who likes to frame documentation comments, I find this issue unbearable. The reason we should except Markdown's dash ---- syntax for headings in LuaCATS is because Lua uses dashes to delimit the comments themselves. And those who frame comments also use the same character (dash) for the rest of the frame. You wouldn't use another character for the frame, it would look ugly and not uniform. For example, in C, Markdown's heading syntax does not conflict with the comment delimiter (//). So you can frame your comments by repeating the comment delimiter itself for a uniform frame.

Log File

Log files have no use in this issue.

Tái hiện sự cố trong extension Visual Studio Code bằng cách di con trỏ lên hàm trong chú thích Lua được đóng khung hiển thị trong báo cáo. Trước tiên, hãy tìm phần xử lý heading Markdown của LuaCATS được dùng cho tài liệu chú thích, sau đó xác minh rằng văn bản “Hello World!” được đóng khung không còn được render dưới dạng heading, trong khi các heading Markdown thông thường vẫn hoạt động.