From 5c86a5329664cd5fd3b81fe991c8d7dc18815e07 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Wed, 23 Dec 2020 07:59:24 +0100 Subject: Improve the string-limit doc string * lisp/emacs-lisp/subr-x.el (string-limit): Mention truncate-string-to-width in the doc string. --- lisp/emacs-lisp/subr-x.el | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'lisp/emacs-lisp/subr-x.el') diff --git a/lisp/emacs-lisp/subr-x.el b/lisp/emacs-lisp/subr-x.el index 8a9424cbb3d..7e17a3464e6 100644 --- a/lisp/emacs-lisp/subr-x.el +++ b/lisp/emacs-lisp/subr-x.el @@ -293,7 +293,11 @@ is returned unchanged. If STRING is longer than LENGTH, return a substring consisting of the first LENGTH characters of STRING. If END is non-nil, return -the last LENGTH characters instead." +the last LENGTH characters instead. + +When shortening strings for display purposes, +`truncate-string-to-width' is almost always a better alternative +than this function." (unless (natnump length) (signal 'wrong-type-argument (list 'natnump length))) (cond -- cgit v1.2.3