acoolname/gitlab.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: Update help docs w/ changes to diagnostic configuration (#208)

Browse Source 
Fix alert for diagnostic configuration update
This commit is contained in:
Harrison (Harry) Cramer
2024-03-03 12:06:14 -05:00
committed by GitHub
parent b5b475ce8b
commit 2943fae3f3
2 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
doc/gitlab.nvim.txt
View File

@@ -205,11 +205,11 @@ you call this function with no values the defaults will be used:
},
},
discussion_signs = {
enabled = true,
skip_resolved_discussion = false,
skip_old_revision_discussion = false,
severity = vim.diagnostic.severity.INFO,
virtual_text = false,
enabled = true, -- Show diagnostics for gitlab comments in the reviewer
skip_resolved_discussion = false, -- Show diagnostics for resolved discussions
severity = vim.diagnostic.severity.INFO, -- ERROR, WARN, INFO, or HINT
virtual_text = false, -- Whether to show the comment text inline as floating virtual text
priority = 100, -- Higher will override LSP warnings, etc
icons = {
comment = "→|",
range = " |",
@@ -367,9 +367,22 @@ These labels will be visible in the summary panel, as long as you provide the
SIGNS AND DIAGNOSTICS *gitlab.nvim.signs-and-diagnostics*
By default when reviewing files you will see diagnostics in the reviewer
for comments that have been added to a review. When the cursor is on
diagnostic line you can view discussion thread by using `vim.diagnostic.show`.
By default when reviewing files, you will see diagnostics for comments that
have been added to a review. These are the default settings:
>lua
discussion_signs = {
enabled = true, -- Show diagnostics for gitlab comments in the reviewer
skip_resolved_discussion = false, -- Show diagnostics for resolved discussions
severity = vim.diagnostic.severity.INFO, -- ERROR, WARN, INFO, or HINT
virtual_text = false, -- Whether to show the comment text inline as floating virtual text
priority = 100, -- Higher will override LSP warnings, etc
icons = {
comment = "→|",
range = " |",
},
},
When the cursor is on diagnostic line you can view discussion thread by using `vim.diagnostic.show()`
You can also jump to discussion tree for the given comment:
>lua

2
lua/gitlab/reviewer/init.lua
View File

@@ -62,7 +62,7 @@ M.open = function()
if state.settings.discussion_diagnostic ~= nil or state.settings.discussion_sign ~= nil then
u.notify(
"Diagnostics are now configured settings.discussion_signs, see :h gitlab.signs_and_diagnostics",
"Diagnostics are now configured as settings.discussion_signs, see :h gitlab.nvim.signs-and-diagnostics",
vim.log.levels.WARN
)
end