bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

[Filipp Gunbin]

subst-char-in-region has its entry, but subst-char-in-string doesn't
have.  It's not clear to me what is the best node to add to: is it
"(elisp) Search and Replace"?

Thanks.


In GNU Emacs 28.0.50 (build 10, x86_64-apple-darwin20.5.0, NS appkit-2022.50 Version 11.4 (Build 20F71))
 of 2021-07-05 built on fgunbin.local
Repository revision: 82c6327555252a00404c62302dcc9effbf8fb90a
Repository branch: master
System Description:  macOS 11.4

bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

[Eli Zaretskii]

> From: Filipp Gunbin <fgunbin@fastmail.fm>
> Date: Mon, 05 Jul 2021 20:13:08 +0300
> 
> 
> subst-char-in-region has its entry, but subst-char-in-string doesn't
> have.  It's not clear to me what is the best node to add to: is it
> "(elisp) Search and Replace"?

I think right next to subst-char-in-region.

bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

[Filipp Gunbin]

[-- Attachment #1: Type: text/plain, Size: 414 bytes --]

tags 49420 + patch
quit

On 05/07/2021 20:24 +0300, Eli Zaretskii wrote:

>> From: Filipp Gunbin <fgunbin@fastmail.fm>
>> Date: Mon, 05 Jul 2021 20:13:08 +0300
>> 
>> 
>> subst-char-in-region has its entry, but subst-char-in-string doesn't
>> have.  It's not clear to me what is the best node to add to: is it
>> "(elisp) Search and Replace"?
>
> I think right next to subst-char-in-region.

Something like this?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch --]
[-- Type: text/x-diff, Size: 1162 bytes --]

From 290b521f7429bed6656a967da204205bbd94c0a3 Mon Sep 17 00:00:00 2001
From: Filipp Gunbin <fgunbin@fastmail.fm>
Date: Wed, 7 Jul 2021 21:51:57 +0300
Subject: [PATCH 2/2] ; * doc/lispref/text.texi (Substitution): Add
 subst-char-in-string (Bug#49420)

---
 doc/lispref/text.texi | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 0c87a19fa1..f6484c4d37 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -4428,6 +4428,16 @@ Substitution
 @end example
 @end defun
 
+
+@defun subst-char-in-string fromchar tochar string &optional inplace
+@cindex replace characters in string
+This function replaces all occurences of the character @var{fromchar}
+with @var{tochar} in @var{string}.  Unless @var{inplace} is non-nil,
+substitution occurs in a copy of @var{string}.  In any case, the
+function returns the resulting string.  Both characters must have the
+same length of multi-byte form.
+@end defun
+
 @deffn Command translate-region start end table
 This function applies a translation table to the characters in the
 buffer between positions @var{start} and @var{end}.
-- 
2.32.0

bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

[Lars Ingebrigtsen]

Filipp Gunbin <fgunbin@fastmail.fm> writes:

> Something like this?

Thanks; applied to Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

[Eli Zaretskii]

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Cc: Eli Zaretskii <eliz@gnu.org>,  49420@debbugs.gnu.org
> Date: Sat, 10 Jul 2021 19:00:24 +0200
> 
> Filipp Gunbin <fgunbin@fastmail.fm> writes:
> 
> > Something like this?
> 
> Thanks; applied to Emacs 28.

Thanks.  I made a minor fix in this change: the part about both
characters having to have the same multibyte length is incorrect (that
restriction is only applicable to subst-char-in-region).  I also fixed
the sentence with double negation ("Unless ... non-nil, ...".)

Sorry I missed the original patch.

bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

[Basil L. Contovounesios]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Lars Ingebrigtsen <larsi@gnus.org>
>> Cc: Eli Zaretskii <eliz@gnu.org>,  49420@debbugs.gnu.org
>> Date: Sat, 10 Jul 2021 19:00:24 +0200
>> 
>> Filipp Gunbin <fgunbin@fastmail.fm> writes:
>> 
>> > Something like this?
>> 
>> Thanks; applied to Emacs 28.
>
> Thanks.  I made a minor fix in this change: the part about both
> characters having to have the same multibyte length is incorrect (that
> restriction is only applicable to subst-char-in-region).  I also fixed
> the sentence with double negation ("Unless ... non-nil, ...".)

Thanks, but did you forget to push the fix?

-- 
Basil

bug#49420: 28.0.50; Add elisp manual entry for subst-char-in-string

[Eli Zaretskii]

> From: "Basil L. Contovounesios" <contovob@tcd.ie>
> Cc: Lars Ingebrigtsen <larsi@gnus.org>,  fgunbin@fastmail.fm,
>   49420@debbugs.gnu.org
> Date: Sun, 11 Jul 2021 09:18:46 +0100
> 
> > Thanks.  I made a minor fix in this change: the part about both
> > characters having to have the same multibyte length is incorrect (that
> > restriction is only applicable to subst-char-in-region).  I also fixed
> > the sentence with double negation ("Unless ... non-nil, ...".)
> 
> Thanks, but did you forget to push the fix?

Oops!