branch: externals/breadcrumb
commit c06c1c6b6d001562a19a5942569576b80117a40a
Author: João Távora <joaotav...@gmail.com>
Commit: João Távora <joaotav...@gmail.com>
* breadcrumb.el (bc--summarize): Fix docstring.
---
breadcrumb.el | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/breadcrumb.el b/breadcrumb.el
index 2bca424336..174d6f3f46 100644
--- a/breadcrumb.el
+++ b/breadcrumb.el
@@ -307,11 +307,11 @@ These structures don't have a `breadcrumb-region'
property on."
(defun bc--summarize (crumbs cutoff separator)
"Return a string that summarizes CRUMBS, a list of strings.
-\"Summarization\" consists of truncating some CRUMBS to 1
-character. Rightmost members of CRUMBS are summarized last.
-Members with a `breadcrumb-dont-shorten' are never truncated.
-Aim for a return string that is at most CUTOFF characters long.
-Join the crumbs with SEPARATOR."
+\"Summarization\" consists of truncating some CRUMBS to 1 character.
+Rightmost members of CRUMBS are summarized last. Members with a non-nil
+`breadcrumb-dont-shorten' property are never truncated. Aim for a
+return string that is at most CUTOFF characters long. Join the crumbs
+with SEPARATOR."
(let ((rcrumbs
(cl-loop
for available = (- cutoff used)
