leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: mark opts parameter as optional in generate function (#195)

Browse Source 
Update the LuaLS/EmmyLua annotation for the `generate` function to explicitly mark the `opts` parameter as optional. 

This change aligns the documentation with the existing implementation and resolves language server warnings when calling the function without arguments.
This commit is contained in:
J
2024-08-22 16:40:50 +08:00
committed by GitHub
parent 2cad4d6fe9
commit d242dd3462
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lua/neogen/init.lua
View File

@@ -147,7 +147,7 @@ neogen.configuration = {
--- For example, if you are inside a function, and called `generate({ type = "func" })`, --- For example, if you are inside a function, and called `generate({ type = "func" })`,
--- Neogen will go until the start of the function and start annotating for you. --- Neogen will go until the start of the function and start annotating for you.
--- ---
---@param opts table Optional configs to change default behaviour of generation. ---@param opts? table Optional configs to change default behaviour of generation.
--- - {opts.type} `(string, default: "any")` Which type we are trying to use for generating annotations. --- - {opts.type} `(string, default: "any")` Which type we are trying to use for generating annotations.
--- Currently supported: `any`, `func`, `class`, `type`, `file` --- Currently supported: `any`, `func`, `class`, `type`, `file`
--- - {opts.annotation_convention} `(table)` convention to use for generating annotations. --- - {opts.annotation_convention} `(table)` convention to use for generating annotations.