Skip to content

Custom documentation not appearing on existing libraries #1247

@Stefanuk12

Description

@Stefanuk12

With the latest update (1.56.0), the ability to add custom documentation to members inside existing libraries (either custom defined functions or pre-existing ones), is not working. When hovering over foo for debug.foo in the init.luau file (view below), no documentation shows at all.

Test case

.vscode/settings.json

{
  "luau-lsp.types.definitionFiles": {
    "@custom": "./example.d.luau"
  },
  "luau-lsp.types.documentationFiles": [
    "./example.d.json"
  ]
}

example.d.luau

type debug = {
    foo: () -> (),
}
declare debug: debug & typeof(debug) -- & here to preserve previous defs

example.d.json

{
    "@custom/global/debug.foo": {
        "documentation": "some docs here"
    }
}

init.luau

local x = debug.foo() -- hover over `foo` here, nothing shows

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions