how to add descrpition for an alias table

[Bilal2453]

I basically want to achieve the following:

---@class argument_options: table
--- the cwd path this will be launched at
---@field cwd string

---@param options argument_options
function some_func(options) end

this shows the description for the cwd field when one does some_func({cwd[ctrl+space]})
I want to achieve this same effect but with aliases, I tried the following but didn't seem to work:

---@alias argument_options {}
---@alias arguments_options.cwd # the cwd path this will be launched at

Is there a way to do this? I don't want to use classes since they show up in the suggestion menu as their own type instead of a table expand.

[C3pa]

What about:

---@alias argument_options
---| `argument_options.cwd` # the cwd path this will be launched at

---@param options argument_options
local function some_func(options) end

?

Result:

[Bilal2453]

Compare this:

To this:

[C3pa]

Well, that's how aliases work. I'd try using a class annotation then. What's your hick up with classes?

[Bilal2453]

Their annotated type is not a table.

Notice here, it is obvious that this is simply a table:

)

Here, it is not obvious that the user is suppose to pass a normal table, they may think they need to initialize some actual class:

[C3pa]

I see what you mean. My approach to the issue is like this:

There is no natural way to mark it as a table in the type system, but it's nice to express that to the users in the description of the some_func.params class.

[Bilal2453]

That is unfortunate! I guess I will have to either accept there will be no field auto-completion in the supplied table, or simply accept the fact I have to make it a class. Will see what I can do about it.