From 052012d2d98d0e97f488111380c28cc53812ea48 Mon Sep 17 00:00:00 2001
From: Daniel <daniel@daniellaing.com>
Date: Wed, 3 Apr 2024 13:11:18 +0100
Subject: [PATCH] plugins/lsp: Improved docs for keymaps

---
 plugins/lsp/default.nix | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/plugins/lsp/default.nix b/plugins/lsp/default.nix
index 61aecbf3..ee38380c 100644
--- a/plugins/lsp/default.nix
+++ b/plugins/lsp/default.nix
@@ -114,7 +114,7 @@ in {
 
         diagnostic = mkOption {
           type = with types; attrsOf (either str attrs);
-          description = "Mappings for `vim.diagnostic.<action>` functions.";
+          description = "Mappings for `vim.diagnostic.<action>` functions to be added when an LSP is attached.";
           example = {
             "<leader>k" = "goto_prev";
             "<leader>j" = "goto_next";
@@ -124,7 +124,7 @@ in {
 
         lspBuf = mkOption {
           type = with types; attrsOf (either str attrs);
-          description = "Mappings for `vim.lsp.buf.<action>` functions.";
+          description = "Mappings for `vim.lsp.buf.<action>` functions to be added when an LSP it attached.";
           example = {
             "gd" = "definition";
             "gD" = "references";
@@ -137,7 +137,10 @@ in {
 
         extra = mkOption {
           type = with types; listOf helpers.keymaps.mapOptionSubmodule;
-          description = "Extra keymaps to register on 'LspAttach'.";
+          description = ''
+            Extra keymaps to register when an LSP is attached.
+            This can be used to customise LSP behaviour, for example with "telescope" or the "Lspsaga" plugin, as seen in the examples.
+          '';
           example = [
             {
               key = "<leader>lx";