mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-30 08:09:04 +00:00
Code Issues Releases Activity

Omit store-substring from lisp manual (bug#70784)

Browse Source 
* doc/lispref/strings.texi (Modifying Strings): Remove `store-substring`
which is not really useful enough to merit a mention here.
This commit is contained in:
Mattias Engdegård 2024-05-25 12:20:30 +02:00
parent d54178f535
commit cb67c34bcf
1 changed files with 1 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/lispref/strings.texi
View File

@ -473,28 +473,12 @@ needed, but we recommend to always make sure @var{string} is multibyte
Representations}), if @var{char} is a non-@acronym{ASCII} character, not
a raw byte.
A more powerful function is @code{store-substring}:
@defun store-substring string idx obj
This function alters part of the contents of the specified @var{string},
by storing @var{obj} starting at character index @var{idx}. The
argument @var{obj} may be either a character (in which case the function
behaves exactly as @code{aset}) or a (smaller) string. If @var{obj}
is a multibyte string, we recommend to make sure @var{string} is also
multibyte, even if it's pure-@acronym{ASCII}.
Since it is impossible to change the number of characters in an
existing string, it is an error if @var{obj} consists of more
characters than would fit in @var{string} starting at character index
@var{idx}.
@end defun
To clear out a string that contained a password, use
@code{clear-string}:
@defun clear-string string
This makes @var{string} a unibyte string and clears its contents to
zeros. It may also change @var{string}'s length.
null characters. It may also change @var{string}'s length.
@end defun
@need 2000