LuaLS / LuaLS/lua-language-server

[Feature Request] Option to have docs on numeric keys on tables

Open
#1,817 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

For example, a map of status code to some table.

local my_status_code_map = {
  -- attached docs
  -- attached docs (continued)
  [200] = { something = "here" }
}
local foo = my_status_code_map[200]
--                            ^^^^^--- i'd like to be able to hover here to get the docs attached to `[200]` in the table

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points; begin by locating hover handling and table-key resolution in the Lua language server. Done means hovering over my_status_code_map[200] shows documentation attached to [200], with coverage for the numeric-key example.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.