Skip to content

Commit

Permalink
doc: better history-related docs
Browse files Browse the repository at this point in the history
  • Loading branch information
j-hui committed Dec 12, 2023
1 parent 9feac13 commit ddd3860
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ For instance, using [Lazy](https://github.com/folke/lazy.nvim):
group_style = "Title", -- Highlight group for group name (LSP server name)
icon_style = "Question", -- Highlight group for group icons
priority = 30, -- Ordering priority for LSP notification group
skip_history = true, -- Whether progress notifications should be omitted from history
format_message = -- How to format a progress message
require("fidget.progress.display").default_format_message,
format_annote = -- How to format a progress annotation
Expand All @@ -193,6 +194,7 @@ For instance, using [Lazy](https://github.com/folke/lazy.nvim):
notification = {
poll_rate = 10, -- How frequently to update and render notifications
filter = vim.log.levels.INFO, -- Minimum notifications level
history_size = 128, -- Number of removed messages to retain in history
override_vim_notify = false, -- Automatically override vim.notify() with Fidget
configs = -- How to configure notification groups when instantiated
{ default = require("fidget.notification").default_config },
Expand Down
2 changes: 1 addition & 1 deletion lua/fidget/notification.lua
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ notification.options = {
---@type 0|1|2|3|4|5
filter = vim.log.levels.INFO,

--- Number of removed messages to keep around
--- Number of removed messages to retain in history
---
--- Set to 0 to keep around history indefinitely (until cleared).
---
Expand Down
2 changes: 1 addition & 1 deletion lua/fidget/progress/display.lua
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ M.options = {
---@type number|false
priority = 30,

--- Whether progress notifications should be retained in history.
--- Whether progress notifications should be omitted from history
---
---@type boolean
skip_history = true,
Expand Down

0 comments on commit ddd3860

Please sign in to comment.