Annotating an anonymous function within a function with variable substitution

[macintacos]

I was trying to type the following function:

---Convenience function that binds a mode to a `vim.keymap.set`.
---@param mode string The mode to map.
---| '""' # Regular noremap (all modes)
---| '"n"' # Normal mode
---| '"i"' # Insert mode
---| '"x"' # Visual (alone) mode
---| '"s"' # Select (alone) mode
---| '"v"' # Visual _and_ Select modes
---| '"c"' # Command-line mode
---| '"o"' # Operator-pending mode
local function bind(mode, outer_opts)
    -- Defaults
    outer_opts = outer_opts or { noremap = true, silent = true }

    ---Convenience function to create a keymap for mode "{mode}"
    ---@param lhs string The mapping to set.
    ---@param rhs string|function The command to execute when the mapping is used.
    ---@param opts? table Options to pass. These are the same options as for `vim.api.nvim_set_keymap`.
    return function(lhs, rhs, opts)
        opts = vim.tbl_extend("force",
            outer_opts,
            opts or {}
        )
        vim.keymap.set(mode, lhs, rhs, opts)
    end
end

I then export the function to be used elsewhere like so:

local M = {}

M.nnoremap = bind("n")
M.inoremap = bind("i")
-- ... etc.

return M

The annotations all work great. However, I was hoping that there would be a way to substitude the mode parameter into the inner docstring on the first line (see the "{mode}") - is there any way to do that such that it substitutes that variable in the inner anonymous function?

Ideally, when retrieving the docstring for the nnoremap function, I would see something like:

Convenience function to create a keymap for mode "n"

And again, for the docstring for inoremap, I would see:

Convenience function to create a keymap for mode "i"

I don't expect my current annotation to work - just trying to see if what I want to do is possible. I read the documentation/searched elsewhere and can't find anyone else trying to do the same thing. Any help would be appreciated!

[C3pa]

Currently, what you are describing can't be achieved. But, of course, you can:

-- Convenience function to create a keymap for mode "n"
M.nnoremap = bind("n")
-- Convenience function to create a keymap for mode "i"
M.inoremap = bind("i")