summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2021-03-24 09:22:40 +0100
committerLars Ingebrigtsen <larsi@gnus.org>2021-03-24 09:22:44 +0100
commita4ececf004e5442fc245ccff910000fe407f7212 (patch)
tree2e7a3a7e9c290db7382dd5c6093a15db74f47310 /doc
parentc0d24d5316626a3d5e76f99a0f418463cb355459 (diff)
downloademacs-a4ececf004e5442fc245ccff910000fe407f7212.tar.gz
emacs-a4ececf004e5442fc245ccff910000fe407f7212.tar.bz2
emacs-a4ececf004e5442fc245ccff910000fe407f7212.zip
Move string-trim functions to subr.el
* doc/lispref/strings.texi (Creating Strings): Document them. * lisp/faces.el: Don't require subr-x, because that leads to build errors. * lisp/subr.el (string-trim, string-trim-right) (string-trim-left): Move here from subr-x.el. * lisp/emacs-lisp/shortdoc.el (string): Adjust.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/strings.texi16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi
index 5cae939b7bf..b4d7bc729f5 100644
--- a/doc/lispref/strings.texi
+++ b/doc/lispref/strings.texi
@@ -390,6 +390,22 @@ whitespace to a single space character, as well as removing all
whitespace from the start and the end of @var{string}.
@end defun
+@defun string-trim-left string &optional regexp
+Remove the leading text that matches @var{regexp} from @var{string}.
+@var{regexp} defaults to @samp{[ \t\n\r]+}.
+@end defun
+
+@defun string-trim-right string &optional regexp
+Remove the trailing text that matches @var{regexp} from @var{string}.
+@var{regexp} defaults to @samp{[ \t\n\r]+}.
+@end defun
+
+@defun string-trim string &optional trim-left trim-right
+Remove the leading text that matches @var{trim-left} and trailing text
+that matches @var{trim-right} from from @var{string}. Both regexps
+default to @samp{[ \t\n\r]+}.
+@end defun
+
@defun string-fill string length
Attempt to Word-wrap @var{string} so that no lines are longer than
@var{length}. Filling is done on whitespace boundaries only. If