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.
This commit is contained in:
Tom MacWright 2025-09-17 05:17:32 -04:00 committed by GitHub
parent 014b5bf6ac
commit ab657e9589
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 19 additions and 6 deletions

View file

@ -1,5 +1,7 @@
return { return {
-- auto pairs -- Auto pairs
-- Automatically inserts a matching closing character
-- when you type an opening character like `"`, `[`, or `(`.
{ {
"nvim-mini/mini.pairs", "nvim-mini/mini.pairs",
event = "VeryLazy", event = "VeryLazy",
@ -20,14 +22,18 @@ return {
end, 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", "folke/ts-comments.nvim",
event = "VeryLazy", event = "VeryLazy",
opts = {}, 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", "nvim-mini/mini.ai",
event = "VeryLazy", event = "VeryLazy",
@ -64,6 +70,8 @@ return {
end, end,
}, },
-- Configures LuaLS to support auto-completion and type checking
-- while editing your Neovim configuration.
{ {
"folke/lazydev.nvim", "folke/lazydev.nvim",
ft = "lua", ft = "lua",

View file

@ -1,5 +1,5 @@
return { return {
-- edgy -- Create and display predefined window layouts.
{ {
"folke/edgy.nvim", "folke/edgy.nvim",
event = "VeryLazy", event = "VeryLazy",

View file

@ -8,7 +8,8 @@ return {
}, },
}, },
-- setup animate -- Animates many common Neovim actions, like scrolling,
-- moving the cursor, and resizing windows.
{ {
"nvim-mini/mini.animate", "nvim-mini/mini.animate",
event = "VeryLazy", event = "VeryLazy",

View file

@ -1,3 +1,4 @@
-- Animates cursor movement with a smear effect.
return { return {
"sphamba/smear-cursor.nvim", "sphamba/smear-cursor.nvim",
event = "VeryLazy", event = "VeryLazy",

View file

@ -1,4 +1,6 @@
return { return {
-- Asynchronously calls language-specific linter tools and reports
-- their results via the `vim.diagnostic` module.
{ {
"mfussenegger/nvim-lint", "mfussenegger/nvim-lint",
event = "LazyFile", event = "LazyFile",

View file

@ -60,7 +60,8 @@ return {
end, end,
}, },
-- statusline -- Displays a fancy status line with git status,
-- LSP diagnostics, filetype information, and more.
{ {
"nvim-lualine/lualine.nvim", "nvim-lualine/lualine.nvim",
event = "VeryLazy", event = "VeryLazy",