mention coc-diagnostics-shim in docs (#5159)

neoclide · Oct 25, 2024 · 5fdf3d6 · 5fdf3d6
1 parent 9fd8578
commit 5fdf3d6
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/data/schema.json b/data/schema.json
@@ -913,7 +913,7 @@
     "diagnostic.displayByAle": {
       "type": "boolean",
       "scope": "language-overridable",
-      "description": "Use Ale for display diagnostics in vim, will disable coc for display diagnostics, restart required on change.",
+      "description": "Use Ale, coc-diagnostics-shim.nvim, or other provider to display diagnostics in vim. This setting will disable diagnostic display using coc's handler. A restart required on change.",
       "default": false
     },
     "diagnostic.enable": {

diff --git a/doc/coc-config.txt b/doc/coc-config.txt
@@ -152,8 +152,9 @@ Diagnostic~
 
 "diagnostic.displayByAle"				*coc-config-diagnostic-displayByAle*
 
-	Use Ale for display diagnostics in vim, will disable coc for display 
-	diagnostics, restart required on change.
+	Use Ale, coc-diagnostics-shim.nvim, or other provider to display
+	diagnostics in vim. This setting will disable diagnostic display using
+	coc's handler. A restart required on change.
 
 	Scope: `language-overridable`, default: `false`
 

diff --git a/doc/coc.txt b/doc/coc.txt
@@ -2468,8 +2468,9 @@ Acceptable {action} names for |CocAction()| and |CocActionAsync()|.
 
 "diagnosticToggle" [{enable}]	 			*CocAction('diagnosticToggle')*
 
-	Enable/disable diagnostics on the fly, not work when `displayByAle` is
-	enabled. You can toggle by specifying {enable}. {enable} can be 0 or 1
+	Enable/disable diagnostics on the fly. This setting is ignored if
+	`displayByAle` is enabled. You can toggle by specifying {enable}.
+	{enable} can be 0 or 1
 
 "diagnosticToggleBuffer" [{bufnr}] [{enable}] 		*CocAction('diagnosticToggleBuffer')*
 

diff --git a/history.md b/history.md
@@ -1,3 +1,7 @@
+# 2024-10-25
+
+- Mention [davidosomething/coc-diagnostics-shim.nvim](https://github.com/davidosomething/coc-diagnostics-shim.nvim) as alternative to ALE for diagnostics display.
+
 # 2024-08-28
 
 - Add configuration `codeLens.display`
@@ -26,7 +30,7 @@
 # 2024-05-29
 
 - Break change: increase minimum vim/nvim version requirement
-  - vim  9.0.0438
+  - vim 9.0.0438
   - nvim 0.8.0
 
 # 2024-05-14