Add a note about flycheck-mode-success-indicator

flycheck · Apr 11, 2024 · bec59ee · bec59ee
1 parent f46f058
commit bec59ee
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -8,7 +8,7 @@ New Features
 - [#1975]: Add support for ``--expt-relaxed-constexpr`` flag to ``cuda`` checker.
 - [#2055]: Add support for ``--expt-extended-lambda`` flag to ``cuda`` checker.
 - [#1987]: Add a flag ``flycheck-auto-display-errors-after-checking`` control whether to display errors automatically after checking.
-- [#2035]: Added colors to FlyC mode line and updated mode line menu.
+- [#2035]: Add colors to FlyC mode line and update mode line menu. Introduce ``flycheck-mode-success-indicator``.
 - [#2059]: Enable checkers for new AUCTeX 14 modes.
 - [#2067]: Handle correctly GHC 9.6 error output format.
 - [#2070]: Add a new syntax checker ``r`` for R with the builtin ``parse`` function.

diff --git a/doc/user/error-reports.rst b/doc/user/error-reports.rst
@@ -272,6 +272,12 @@ You can entirely customise the mode line indicator with `flycheck-mode-line`:
 
    A “mode line construct” for Flycheck’s mode line indicator.
 
+You can also customize the indicator for a successful run (no errors/warnings found) with `flycheck-mode-success-indicator`:
+
+.. defcustom:: flycheck-mode-success-indicator
+
+   Success indicator appended to `flycheck-mode-line-prefix'. Set to ":0" by default.
+
 .. seealso::
 
    :infonode:`(elisp)Mode Line Data`