This annotation is intended for complex cases and is primarily designed to be used by the built-in annotations.
Overview
return_alias marks a function whose first return value is the same value it was given in one argument, not a copy. assert is one: assert(x) returns x itself.
GLuaLS then treats the result as the argument itself. Methods you add through the result go on the original.
Syntax
@return line. index is the zero-based position of the returned argument.
Example
The official annotations describeassert like this:
See also
@copy_result: a function that returns a copy of its argument