From ab657e95898648bae210815bd641aa1a1fae5472 Mon Sep 17 00:00:00 2001
From: Tom MacWright <tmcw@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:17:32 -0400
Subject: [PATCH] docs: improved plugin doc strings (#5657)

## Description

This improves the comment strings that produce documentation for
different plugins. I often look at the docs to learn what stuff is
already installed, and this would help people like me to quickly
understand what some of the plugins do.

## Checklist

- [x] I've read the
[CONTRIBUTING](https://github.com/LazyVim/LazyVim/blob/main/CONTRIBUTING.md)
guidelines.
---
 lua/lazyvim/plugins/coding.lua                 | 14 +++++++++++---
 lua/lazyvim/plugins/extras/ui/edgy.lua         |  2 +-
 lua/lazyvim/plugins/extras/ui/mini-animate.lua |  3 ++-
 lua/lazyvim/plugins/extras/ui/smear-cursor.lua |  1 +
 lua/lazyvim/plugins/linting.lua                |  2 ++
 lua/lazyvim/plugins/ui.lua                     |  3 ++-
 6 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/lua/lazyvim/plugins/coding.lua b/lua/lazyvim/plugins/coding.lua
index 8b242eb8..7f6bb550 100644
--- a/lua/lazyvim/plugins/coding.lua
+++ b/lua/lazyvim/plugins/coding.lua
@@ -1,5 +1,7 @@
 return {
-  -- auto pairs
+  -- Auto pairs
+  -- Automatically inserts a matching closing character
+  -- when you type an opening character like `"`, `[`, or `(`.
   {
     "nvim-mini/mini.pairs",
     event = "VeryLazy",
@@ -20,14 +22,18 @@ return {
     end,
   },
 
-  -- comments
+  -- Improves comment syntax, lets Neovim handle multiple
+  -- types of comments for a single language, and relaxes rules
+  -- for uncommenting.
   {
     "folke/ts-comments.nvim",
     event = "VeryLazy",
     opts = {},
   },
 
-  -- Better text-objects
+  -- Extends the a & i text objects, this adds the ability to select
+  -- arguments, function calls, text within quotes and brackets, and to
+  -- repeat those selections to select an outer text object.
   {
     "nvim-mini/mini.ai",
     event = "VeryLazy",
@@ -64,6 +70,8 @@ return {
     end,
   },
 
+  -- Configures LuaLS to support auto-completion and type checking
+  -- while editing your Neovim configuration.
   {
     "folke/lazydev.nvim",
     ft = "lua",
diff --git a/lua/lazyvim/plugins/extras/ui/edgy.lua b/lua/lazyvim/plugins/extras/ui/edgy.lua
index dbe76d1b..bf522270 100644
--- a/lua/lazyvim/plugins/extras/ui/edgy.lua
+++ b/lua/lazyvim/plugins/extras/ui/edgy.lua
@@ -1,5 +1,5 @@
 return {
-  -- edgy
+  -- Create and display predefined window layouts.
   {
     "folke/edgy.nvim",
     event = "VeryLazy",
diff --git a/lua/lazyvim/plugins/extras/ui/mini-animate.lua b/lua/lazyvim/plugins/extras/ui/mini-animate.lua
index 5a3fdef6..b71c19a9 100644
--- a/lua/lazyvim/plugins/extras/ui/mini-animate.lua
+++ b/lua/lazyvim/plugins/extras/ui/mini-animate.lua
@@ -8,7 +8,8 @@ return {
     },
   },
 
-  -- setup animate
+  -- Animates many common Neovim actions, like scrolling,
+  -- moving the cursor, and resizing windows.
   {
     "nvim-mini/mini.animate",
     event = "VeryLazy",
diff --git a/lua/lazyvim/plugins/extras/ui/smear-cursor.lua b/lua/lazyvim/plugins/extras/ui/smear-cursor.lua
index 2ca27780..4ab6f03e 100644
--- a/lua/lazyvim/plugins/extras/ui/smear-cursor.lua
+++ b/lua/lazyvim/plugins/extras/ui/smear-cursor.lua
@@ -1,3 +1,4 @@
+-- Animates cursor movement with a smear effect.
 return {
   "sphamba/smear-cursor.nvim",
   event = "VeryLazy",
diff --git a/lua/lazyvim/plugins/linting.lua b/lua/lazyvim/plugins/linting.lua
index 46cf2898..9b1bed29 100644
--- a/lua/lazyvim/plugins/linting.lua
+++ b/lua/lazyvim/plugins/linting.lua
@@ -1,4 +1,6 @@
 return {
+  -- Asynchronously calls language-specific linter tools and reports
+  -- their results via the `vim.diagnostic` module.
   {
     "mfussenegger/nvim-lint",
     event = "LazyFile",
diff --git a/lua/lazyvim/plugins/ui.lua b/lua/lazyvim/plugins/ui.lua
index 9dd7254b..23afdc39 100644
--- a/lua/lazyvim/plugins/ui.lua
+++ b/lua/lazyvim/plugins/ui.lua
@@ -60,7 +60,8 @@ return {
     end,
   },
 
-  -- statusline
+  -- Displays a fancy status line with git status,
+  -- LSP diagnostics, filetype information, and more.
   {
     "nvim-lualine/lualine.nvim",
     event = "VeryLazy",