branch: externals/consult
commit b1c0443c033ec619f8dafb377d7bd992f081b293
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
consult-compile-error, consult-grep-match: Improve docstrings
---
consult-compile.el | 9 +++++----
consult.el | 3 ++-
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/consult-compile.el b/consult-compile.el
index 95064ae2d2..ecb7e26376 100644
--- a/consult-compile.el
+++ b/consult-compile.el
@@ -19,9 +19,10 @@
;;; Commentary:
-;; Provides the command `consult-compile-error'. This is an extra
-;; package, to allow lazy loading of compile.el. The
-;; `consult-compile-error' command is autoloaded.
+;; Provides the command `consult-compile-error'. This is an extra package, to
+;; allow lazy loading of compile.el. The `consult-compile-error' command is
+;; autoloaded. See also the command `consult-grep-match' which adapts
+;; `consult-compile-error' to Grep buffers.
;;; Code:
@@ -99,7 +100,7 @@ This command collects entries from all related compilation
buffers. The
command supports preview of the currently selected error. With prefix
ARG, jump to the error message in the compilation buffer, instead of to
the actual location of the error. If GREP is non-nil, Grep buffers are
-searched."
+searched. See also `consult-grep-match'."
(interactive "P")
(consult--read
(or (mapcan #'consult-compile--candidates
diff --git a/consult.el b/consult.el
index 1eefef3c94..b9386df9e8 100644
--- a/consult.el
+++ b/consult.el
@@ -5239,7 +5239,8 @@ input."
This command collects entries from all related Grep buffers. The
command supports preview of the currently selected match. With prefix
ARG, jump to the match in the Grep buffer, instead of to the actual
-location of the match."
+location of the match. This command is a thin wrapper around
+`consult-compile-error'."
(interactive "P")
(consult-compile-error arg t))
