diff options
| author | Ruijie Yu <ruijie+git@netyu.xyz> | 2023-05-12 22:21:32 +0800 |
|---|---|---|
| committer | João Távora <joaotavora@gmail.com> | 2023-05-12 15:49:50 +0100 |
| commit | 9800e6fc60419c4293d5e62b22f1629720f7abb5 (patch) | |
| tree | 193ddb62691c5f922d1c6bb0e4301ad50d91130b | |
| parent | eb7c97d4147cbef60a3b51b26299ce5d39e1c356 (diff) | |
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.
| -rw-r--r-- | breadcrumb.el | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/breadcrumb.el b/breadcrumb.el index bcb27b9..093ef29 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) |