Skip to content

[BUG] lsp server options (e.g. config) have unsuitable default example #4505

Description

@belamu

Plugin

lsp

Nixpkgs Release

unstable

Home Manager Release

unstable

I have read the FAQ

  • I have read the FAQ and my bug is not listed there.

Description

When looking at the documentation for an LSP server, e.g. tinymist, I see an example that is misleading because the configuration options listed in the example are unsuitable for this language server.

So I checked where I could change this documentation but it is generic for all LSP servers in modules/lsp/servers/server.nix which is used in modules/lsp/servers.default.nix with the list of servers in modules/lsp/servers/packages.nix.
server.nix offers the option to overwrite or append to documentation via the config attribute but it is unclear to me how to use these options and I could not find an example server where this is used.

I would find it useful if you could create a showcase:

  • change the example for the tinymist server option config to
{
  settings = {
    formatterMode = "typstyle";
  };
}
  • add to the description of tinymist
Configuration options are described in the [tinymist documentation](https://myriad-dreamin.github.io/tinymist/)
  • add the sentence tinymist is a language server for the typesetting system typst. to the top of the docs page

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions