aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRüdiger Sonderfeld2014-01-10 18:54:32 +0100
committerRüdiger Sonderfeld2014-01-10 18:54:32 +0100
commitb4256e8c52981cf8a9674fbadb81082f8d30c4c5 (patch)
treee4029fd1bedbe4a25913bf60926359c008e41b76 /doc
parent7e03bb327b5dd3a53840a8f1c00e765f3eb3e2f0 (diff)
downloademacs-b4256e8c52981cf8a9674fbadb81082f8d30c4c5.tar.gz
emacs-b4256e8c52981cf8a9674fbadb81082f8d30c4c5.zip
Revert "Document `subr-x' functions."
This reverts 2014-01-10T12:41:19Z!ruediger@c-plusplus.de.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog8
-rw-r--r--doc/lispref/hash.texi1
-rw-r--r--doc/lispref/strings.texi91
3 files changed, 0 insertions, 100 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 3a362c7daa5..2963ffc9a60 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,11 +1,3 @@
12014-01-10 Rüdiger Sonderfeld <ruediger@c-plusplus.de>
2
3 * hash.texi (Hash Tables): Add cindex entry for `subr-x'
4 functions.
5
6 * strings.texi (Creating Strings, Text Comparison): Document
7 functions from `subr-x'.
8
92014-01-09 Rüdiger Sonderfeld <ruediger@c-plusplus.de> 12014-01-09 Rüdiger Sonderfeld <ruediger@c-plusplus.de>
10 2
11 * text.texi (Parsing HTML/XML): Document `shr-insert-document'. 3 * text.texi (Parsing HTML/XML): Document `shr-insert-document'.
diff --git a/doc/lispref/hash.texi b/doc/lispref/hash.texi
index 9d6302f4073..5d0d6b6c89e 100644
--- a/doc/lispref/hash.texi
+++ b/doc/lispref/hash.texi
@@ -354,7 +354,6 @@ This returns the rehash threshold of @var{table}.
354This returns the current nominal size of @var{table}. 354This returns the current nominal size of @var{table}.
355@end defun 355@end defun
356 356
357@cindex Hash table functions in subr-x.
358The following two functions are provided by the @file{subr-x} library. 357The following two functions are provided by the @file{subr-x} library.
359To use them, you need to load this library first. 358To use them, you need to load this library first.
360 359
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi
index b6972ad9cc5..5c814b22b2d 100644
--- a/doc/lispref/strings.texi
+++ b/doc/lispref/strings.texi
@@ -365,83 +365,6 @@ The default value of @var{separators} for @code{split-string}. Its
365usual value is @w{@code{"[ \f\t\n\r\v]+"}}. 365usual value is @w{@code{"[ \f\t\n\r\v]+"}}.
366@end defvar 366@end defvar
367 367
368@cindex String creation functions in subr-x
369 The following functions are provided by the @file{subr-x} library.
370To use them, you need to load this library first.
371
372@defun string-join strings &optional separator
373This joins all strings in @var{strings}. If the optional argument
374@var{separator} is non-@code{nil} then its value is added between each
375string.
376
377@example
378(string-join '("foo" "bar"))
379 @result{} "foobar"
380(string-join '("foo" "bar") ", ")
381 @result{} "foo, bar"
382@end example
383@end defun
384
385@defun string-reverse string
386This function returns the reversed value of @var{string}.
387
388@example
389(string-reverse "ung olleh")
390 @result{} "hello gnu"
391@end example
392@end defun
393
394@defun string-trim-left string
395This function returns a string with all the leading whitespace removed
396from @var{string}. Trailing whitespace are left.
397
398@example
399(string-trim-left "\r\n\t abc ")
400 @result{} "abc "
401@end example
402@end defun
403
404@defun string-trim-right string
405This function returns a string with all the trailing whitespace
406removed from @var{string}. Leading whitespace are left.
407
408@example
409(string-trim-left " abc ")
410 @result{} " abc"
411@end example
412@end defun
413
414@defun string-trim string
415This function returns a string with all leading and trailing
416whitespace from @var{string} removed. This has the same effect as
417calling @code{string-trim-left} and @code{string-trim-right} on
418@var{string}.
419@end defun
420
421@defun string-remove-prefix prefix string
422This removes the string @var{prefix} from the beginning of
423@var{string} if present.
424
425@example
426(string-remove-prefix "foo" "foobar")
427 @result{} "bar"
428(string-remove-prefix "not" "foobar")
429 @result{} "foobar"
430@end example
431@end defun
432
433@defun string-remove-suffix suffix string
434This removes the string @var{suffix} from the end of @var{string} if
435present.
436
437@example
438(string-remove-suffix "bar" "foobar")
439 @result{} "foo"
440(string-remove-suffix "not" "foobar")
441 @result{} "foobar"
442@end example
443@end defun
444
445@node Modifying Strings 368@node Modifying Strings
446@section Modifying Strings 369@section Modifying Strings
447 370
@@ -648,20 +571,6 @@ function @code{string-match}, which matches a regular expression
648against a string, can be used for a kind of string comparison; see 571against a string, can be used for a kind of string comparison; see
649@ref{Regexp Search}. 572@ref{Regexp Search}.
650 573
651@cindex String comparisson functions in subr-x
652 The following functions are provided by the @file{subr-x} library.
653To use them, you need to load this library first.
654
655@defun string-empty-p string
656This function returns non-@code{nil} if @var{string} is an empty
657string.
658@end defun
659
660@defun string-blank-p string
661This function returns non-@code{nil} if @var{string} is either empty
662or only whitespace.
663@end defun
664
665@node String Conversion 574@node String Conversion
666@section Conversion of Characters and Strings 575@section Conversion of Characters and Strings
667@cindex conversion of strings 576@cindex conversion of strings