emacs-29 cf31182684 1/2: ; * lisp/files.el (insert-directory-wildcard-in-dir-p): Doc fix.

[Eli Zaretskii]

branch: emacs-29
commit cf311826841748c6865c713a4b010105e199efa7
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>

    ; * lisp/files.el (insert-directory-wildcard-in-dir-p): Doc fix.
---
 lisp/files.el | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/lisp/files.el b/lisp/files.el
index 18a046e9bb..a9a5baf1ba 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -7674,9 +7674,12 @@ regardless of the language.")
 (defvar insert-directory-ls-version 'unknown)
 
 (defun insert-directory-wildcard-in-dir-p (dir)
-  "Return non-nil if DIR contents a shell wildcard in the directory part.
-The return value is a cons (DIR . WILDCARDS); DIR is the
-`default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
+  "Return non-nil if DIR contains shell wildcards in its parent directory part.
+The return value is a cons (DIRECTORY . WILDCARD), where DIRECTORY is the
+part of DIR up to and excluding the first component that includes
+wildcard characters, and WILDCARD is the rest of DIR's components.  The
+DIRECTORY part of the value includes the trailing slash, to indicate that
+it is a directory.
 
 Valid wildcards are `*', `?', `[abc]' and `[a-z]'."
   (let ((wildcards "[?*"))