branch: externals/consult
commit ba81bd939d79cc6999cf02d09cbeccf4dc9381ed
Author: Daniel Mendler <[email protected]>
Commit: Daniel Mendler <[email protected]>
Improve file descriptions
---
consult-compile.el | 10 +++++-----
consult-flymake.el | 7 +++----
consult-imenu.el | 5 +++--
consult-info.el | 7 +++----
consult-kmacro.el | 7 +++----
consult-org.el | 6 +++---
consult-register.el | 3 ++-
consult-xref.el | 5 ++---
8 files changed, 24 insertions(+), 26 deletions(-)
diff --git a/consult-compile.el b/consult-compile.el
index 007d3ff7d3..c3ab6b859d 100644
--- a/consult-compile.el
+++ b/consult-compile.el
@@ -1,4 +1,4 @@
-;;; consult-compile.el --- Provides the command `consult-compile-error' -*-
lexical-binding: t -*-
+;;; consult-compile.el --- Consult commands to navigate compilation errors -*-
lexical-binding: t -*-
;; Copyright (C) 2021-2026 Free Software Foundation, Inc.
@@ -19,10 +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. See also the command `consult-grep-match' which adapts
-;; `consult-compile-error' to Grep buffers.
+;; Provides the command `consult-compile-error'. This is an extra file to
+;; allow lazy loading of compile.el. See also the command
+;; `consult-grep-match' which adapts `consult-compile-error' to Grep
+;; buffers.
;;; Code:
diff --git a/consult-flymake.el b/consult-flymake.el
index c01c486bc2..3235b08260 100644
--- a/consult-flymake.el
+++ b/consult-flymake.el
@@ -1,4 +1,4 @@
-;;; consult-flymake.el --- Provides the command `consult-flymake' -*-
lexical-binding: t -*-
+;;; consult-flymake.el --- Consult commands to navigate Flymake errors -*-
lexical-binding: t -*-
;; Copyright (C) 2021-2026 Free Software Foundation, Inc.
@@ -19,9 +19,8 @@
;;; Commentary:
-;; Provides the command `consult-flymake'. This is an extra package,
-;; to allow lazy loading of flymake.el. The `consult-flymake' command
-;; is autoloaded.
+;; Provides the command `consult-flymake'. This is an extra file to allow lazy
+;; loading of flymake.el.
;;; Code:
diff --git a/consult-imenu.el b/consult-imenu.el
index d0b67bb669..f2a8ce36de 100644
--- a/consult-imenu.el
+++ b/consult-imenu.el
@@ -1,4 +1,4 @@
-;;; consult-imenu.el --- Consult commands for imenu -*- lexical-binding: t -*-
+;;; consult-imenu.el --- Consult commands to navigate the Imenu -*-
lexical-binding: t -*-
;; Copyright (C) 2021-2026 Free Software Foundation, Inc.
@@ -19,7 +19,8 @@
;;; Commentary:
-;; Provides imenu-related Consult commands.
+;; Provides the commands `consult-imenu' and `consult-imenu-multi'. This is an
+;; extra file to allow lazy loading of imenu.el.
;;; Code:
diff --git a/consult-info.el b/consult-info.el
index 096f6f9ccf..45e1421829 100644
--- a/consult-info.el
+++ b/consult-info.el
@@ -1,4 +1,4 @@
-;;; consult-info.el --- Search through the info manuals -*- lexical-binding: t
-*-
+;;; consult-info.el --- Consult commands to search the info manuals -*-
lexical-binding: t -*-
;; Copyright (C) 2021-2026 Free Software Foundation, Inc.
@@ -19,9 +19,8 @@
;;; Commentary:
-;; Provides the command `consult-info'. This is an extra package,
-;; to allow lazy loading of info.el. The `consult-info' command
-;; is autoloaded.
+;; Provides the command `consult-info' and the macro `consult-info-define'.
+;; This is an extra file to allow lazy loading of info.el.
;;; Code:
diff --git a/consult-kmacro.el b/consult-kmacro.el
index a76209cebb..fe5e70b433 100644
--- a/consult-kmacro.el
+++ b/consult-kmacro.el
@@ -1,4 +1,4 @@
-;;; consult-kmacro.el --- Provides the command `consult-kmacro' -*-
lexical-binding: t -*-
+;;; consult-kmacro.el --- Consult commands to run keyboard macros -*-
lexical-binding: t -*-
;; Copyright (C) 2021-2026 Free Software Foundation, Inc.
@@ -19,9 +19,8 @@
;;; Commentary:
-;; Provides the command `consult-kmacro'. This is an extra package,
-;; to allow lazy loading of kmacro.el. The `consult-kmacro' command
-;; is autoloaded.
+;; Provides the command `consult-kmacro'. This is an extra file to allow lazy
+;; loading of kmacro.el.
;;; Code:
diff --git a/consult-org.el b/consult-org.el
index c1a6bb173d..8619050170 100644
--- a/consult-org.el
+++ b/consult-org.el
@@ -1,4 +1,4 @@
-;;; consult-org.el --- Consult commands for org-mode -*- lexical-binding: t -*-
+;;; consult-org.el --- Consult commands to navigate Org files -*-
lexical-binding: t -*-
;; Copyright (C) 2021-2026 Free Software Foundation, Inc.
@@ -19,8 +19,8 @@
;;; Commentary:
-;; Provides a `completing-read' interface for Org mode navigation.
-;; This is an extra package, to allow lazy loading of Org.
+;; Provides the commands `consult-org-agenda' and `consult-org-heading'. This
+;; is an extra file to allow lazy loading of org.el.
;;; Code:
diff --git a/consult-register.el b/consult-register.el
index 0111227560..a5ff258ef8 100644
--- a/consult-register.el
+++ b/consult-register.el
@@ -19,7 +19,8 @@
;;; Commentary:
-;; Provides register-related Consult commands.
+;; Provides the register-related commands `consult-register',
+;; `consult-register-load' and `consult-register-store'.
;;; Code:
diff --git a/consult-xref.el b/consult-xref.el
index f44113a16b..445b0dad33 100644
--- a/consult-xref.el
+++ b/consult-xref.el
@@ -19,9 +19,8 @@
;;; Commentary:
-;; Provides Xref integration for Consult. This is an extra package, to
-;; allow lazy loading of xref.el. The `consult-xref' function is
-;; autoloaded.
+;; Provides the `consult-xref' function which integrates Consult into Xref.
+;; This is an extra file to allow lazy loading of xref.el.
;;; Code:
