Literal values in the type definition lead to empty docs

[mfussenegger]

lua-language-server supports defining literals/an sum type inline in the type definition. An example: @param x "foo"|"bar"

But this seems to break lemmy-help:

local M = {}

--- Foobar
---@param t? "foo"|"bar"
function M.foo(t)
  print(t)
end

return M

Results in:

❮ lemmy-help -f foo.lua
M.foo()                                                                  *M.foo*


vim:tw=78:ts=8:noet:ft=help:norl:

Compared with a regular type definition:

local M = {}

--- Foobar
---@param t? string
function M.foo(t)
  print(t)
end

return M

Which works as expected:

❮ lemmy-help -f foo.lua
M.foo({t?})                                                              *M.foo*
     Foobar

    Parameters: ~
        {t?}  (string)


vim:tw=78:ts=8:noet:ft=help:norl:

The long form also works:

local M = {}

--- Foobar
---@param t? string
---|"foo"
---|"bar"
function M.foo(t)
  print(t)
end

return M

❮ lemmy-help -f foo.lua
M.foo({t?})                                                              *M.foo*
     Foobar

    Parameters: ~
        {t?}  (string)  |"foo"
                        |"bar"


vim:tw=78:ts=8:noet:ft=help:norl:

[numToStr]

Fow now enum variants needs to be wrapped with single quote (') whether it's inline or defined with ----@alias. This is a constraint that I deliberately put in otherwise I have to parse different constructs.

---@param t? '"foo"'|'"bar"'

---@alias T
---| '"foo"' # Foo Variant
---| '"bar"' # Bar Variant

There is also ` which allows identifiers as variant, but currently is not supported. https://github.com/sumneko/lua-language-server/wiki/Annotations#alias

[mfussenegger]

Fow now enum variants needs to be wrapped with single quote (') whether it's inline or defined with ----@alias.

Oh that's good to know. Thanks