emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/breadcrumb 9800e6fc60 05/18: Minor changes


From: ELPA Syncer
Subject: [elpa] externals/breadcrumb 9800e6fc60 05/18: Minor changes
Date: Tue, 5 Sep 2023 06:57:41 -0400 (EDT)

branch: externals/breadcrumb
commit 9800e6fc60419c4293d5e62b22f1629720f7abb5
Author: Ruijie Yu <ruijie+git@netyu.xyz>
Commit: João Távora <joaotavora@gmail.com>

    Minor changes
    
    * breadcrumb.el (bc--ipath-plain-cache): (bc--idle-timer):
    (bc--last-update-tick): Ensure the docstrings refer to full names
    of defined functions, otherwise docstrings cannot resolve the
    references.
    (bc--header-line): Same.  Ensure a full stop in docstring line 1.
    (bc-jump): Avoid full stop in `user-error', prompted by flymake.
---
 breadcrumb.el | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/breadcrumb.el b/breadcrumb.el
index bcb27b99b4..093ef2956a 100644
--- a/breadcrumb.el
+++ b/breadcrumb.el
@@ -128,7 +128,7 @@ node."
     (nreverse (search index-alist))))
 
 (defvar-local bc--ipath-plain-cache nil
-  "A cache for `bc--ipath-plain'")
+  "A cache for `breadcrumb--ipath-plain'.")
 
 (defun bc--ipath-plain (index-alist pos)
   "Compute ipath for plain `imenu--index-alist' structures.
@@ -174,10 +174,10 @@ These structures don't have a `breadcrumb-region' 
property on."
   "Control idle time before requesting new breadcrumbs.")
 
 (defvar-local bc--idle-timer nil
-  "Timer used by `bc--ipath-alist'.")
+  "Timer used by `breadcrumb--ipath-alist'.")
 
 (defvar-local bc--last-update-tick 0
-  "Last time `bc--ipath-alist' asked for an update.")
+  "Last time `breadcrumb--ipath-alist' asked for an update.")
 
 (defun bc--ipath-alist ()
   "Return `imenu--index-alist', maybe arrange for its update."
@@ -263,7 +263,7 @@ These structures don't have a `breadcrumb-region' property 
on."
                bc-project-crumb-separator)))))
 
 (defun bc--header-line ()
-  "Helper for bc-headerline-mode"
+  "Helper for `breadcrumb-headerline-mode'."
   (let ((x (cl-remove-if
             #'seq-empty-p (mapcar #'funcall
                                   '(bc-project-crumbs bc-imenu-crumbs)))))
@@ -305,7 +305,7 @@ These structures don't have a `breadcrumb-region' property 
on."
             do (dfs (cdr n) newpath))))
       (imenu--make-index-alist)
       (dfs imenu--index-alist)
-      (unless cands (user-error "Sorry, no breadcrumb items to jump to."))
+      (unless cands (user-error "Sorry, no breadcrumb items to jump to"))
       (setq choice (cdr (assoc (completing-read "Index item? " cands nil t)
                                cands #'string=)))
       (push-mark)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]