* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
[not found] ` <20200927124522.BA20F207E0@vcs0.savannah.gnu.org>
@ 2020-09-28 9:42 ` Robert Pluim
2020-09-28 9:59 ` Mattias Engdegård
0 siblings, 1 reply; 23+ messages in thread
From: Robert Pluim @ 2020-09-28 9:42 UTC (permalink / raw)
To: emacs-devel; +Cc: Mattias Engdegård
>>>>> On Sun, 27 Sep 2020 08:45:22 -0400 (EDT), Mattias Engdegård <mattiase@savannah.gnu.org> said:
Mattias> @defun string-replace fromstring tostring instring
Mattias> -This function copies @var{instring} and replaces any occurrences of
Mattias> -@var{fromstring} with @var{tostring}.
Mattias> +This function returns a string equal to @var{instring} where any
Mattias> +occurrences of @var{fromstring} have been replaced with
Mattias> +@var{tostring}. It may return one of its arguments.
Mattias> +Case is significant, and text properties are ignored.
Mattias> @end defun
'equal'? Really? And itʼs kind of passive-voicey. How about:
This function replaces any occurences of @var{fromstring} with
@var{tostring} in @var{instring} and returns the result.
Robert
--
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 9:42 ` master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598) Robert Pluim
@ 2020-09-28 9:59 ` Mattias Engdegård
2020-09-28 11:09 ` Robert Pluim
0 siblings, 1 reply; 23+ messages in thread
From: Mattias Engdegård @ 2020-09-28 9:59 UTC (permalink / raw)
To: Robert Pluim; +Cc: emacs-devel
28 sep. 2020 kl. 11.42 skrev Robert Pluim <rpluim@gmail.com>:
> Mattias> @defun string-replace fromstring tostring instring
> Mattias> -This function copies @var{instring} and replaces any occurrences of
> Mattias> -@var{fromstring} with @var{tostring}.
> Mattias> +This function returns a string equal to @var{instring} where any
> Mattias> +occurrences of @var{fromstring} have been replaced with
> Mattias> +@var{tostring}. It may return one of its arguments.
> Mattias> +Case is significant, and text properties are ignored.
> Mattias> @end defun
>
> 'equal'? Really? And itʼs kind of passive-voicey.
Thank you for scrutinising my changes!
For technical documentation, a declarative or functional style is often appropriate than a procedural one. We would prefer defining (+ A B) as the sum of A and B instead of saying that it takes A, then adds B, and finally returns the result.
> How about:
>
> This function replaces any occurences of @var{fromstring} with
> @var{tostring} in @var{instring} and returns the result.
That is probably fine. I wanted there to be no reason to misread it as a mutation of INSTRING, but the risk is probably minimal. I'll amend the text.
Thanks again!
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 9:59 ` Mattias Engdegård
@ 2020-09-28 11:09 ` Robert Pluim
[not found] ` <CAJnXXojjUAcRVmsZNWQ2j9rSDv76Y0od4yWfVg11k-Q2tf4NYA@mail.gmail.com>
0 siblings, 1 reply; 23+ messages in thread
From: Robert Pluim @ 2020-09-28 11:09 UTC (permalink / raw)
To: Mattias Engdegård; +Cc: emacs-devel
>>>>> On Mon, 28 Sep 2020 11:59:43 +0200, Mattias Engdegård <mattiase@acm.org> said:
Mattias> 28 sep. 2020 kl. 11.42 skrev Robert Pluim <rpluim@gmail.com>:
Mattias> @defun string-replace fromstring tostring instring
Mattias> -This function copies @var{instring} and replaces any occurrences of
Mattias> -@var{fromstring} with @var{tostring}.
Mattias> +This function returns a string equal to @var{instring} where any
Mattias> +occurrences of @var{fromstring} have been replaced with
Mattias> +@var{tostring}. It may return one of its arguments.
Mattias> +Case is significant, and text properties are ignored.
Mattias> @end defun
>>
>> 'equal'? Really? And itʼs kind of passive-voicey.
Mattias> Thank you for scrutinising my changes!
Mattias> For technical documentation, a declarative or functional style is
Mattias> often appropriate than a procedural one. We would prefer defining (+ A
Mattias> B) as the sum of A and B instead of saying that it takes A, then adds
Mattias> B, and finally returns the result.
OK, but in this case the 'have been replaced' is less direct than it
could be.
>> How about:
>>
>> This function replaces any occurences of @var{fromstring} with
>> @var{tostring} in @var{instring} and returns the result.
Mattias> That is probably fine. I wanted there to be no reason to
Mattias> misread it as a mutation of INSTRING, but the risk is
Mattias> probably minimal. I'll amend the text.
Emacs documentation spoils me: destructive modification is called out
explicitly when it can happen, which means I assume that if itʼs not
mentioned, it canʼt happen.
Robert
--
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
[not found] ` <CAJnXXojjUAcRVmsZNWQ2j9rSDv76Y0od4yWfVg11k-Q2tf4NYA@mail.gmail.com>
@ 2020-09-28 13:50 ` Robert Pluim
2020-09-28 16:36 ` John Yates
0 siblings, 1 reply; 23+ messages in thread
From: Robert Pluim @ 2020-09-28 13:50 UTC (permalink / raw)
To: John Yates; +Cc: Mattias Engdegård, emacs-devel
>>>>> On Mon, 28 Sep 2020 07:43:03 -0400, John Yates <john@yates-sheets.org> said:
John> Is there a role for the imperative mood?
John> Return @var{instring} after replacing every occurence of
John> @var{fromstring} with @var{tostring}.
John> I find it typically shorter and more contractual.
I think that fails to pass Mattias' requirement of making it clear
that the returned string is not a destructively modified 'instring'
Robert
--
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 13:50 ` Robert Pluim
@ 2020-09-28 16:36 ` John Yates
2020-09-28 16:49 ` Drew Adams
0 siblings, 1 reply; 23+ messages in thread
From: John Yates @ 2020-09-28 16:36 UTC (permalink / raw)
To: Robert Pluim; +Cc: Mattias Engdegård, Emacs developers
Okay. Then how about
Return a string equal to @var{instring} with every occurence of
@var{fromstring} replaced by @var{tostring}.
On Mon, Sep 28, 2020 at 9:50 AM Robert Pluim <rpluim@gmail.com> wrote:
>
> >>>>> On Mon, 28 Sep 2020 07:43:03 -0400, John Yates <john@yates-sheets.org> said:
>
> John> Is there a role for the imperative mood?
> John> Return @var{instring} after replacing every occurence of
> John> @var{fromstring} with @var{tostring}.
>
> John> I find it typically shorter and more contractual.
>
> I think that fails to pass Mattias' requirement of making it clear
> that the returned string is not a destructively modified 'instring'
>
> Robert
> --
--
John Yates
505 Tremont St, #803
Boston, MA 02116
^ permalink raw reply [flat|nested] 23+ messages in thread
* RE: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 16:36 ` John Yates
@ 2020-09-28 16:49 ` Drew Adams
2020-09-28 16:55 ` Eli Zaretskii
2020-09-28 17:44 ` John Yates
0 siblings, 2 replies; 23+ messages in thread
From: Drew Adams @ 2020-09-28 16:49 UTC (permalink / raw)
To: John Yates, Robert Pluim; +Cc: Mattias Engdegård, Emacs developers
> Okay. Then how about
>
> Return a string equal to @var{instring} with every occurence of
> @var{fromstring} replaced by @var{tostring}.
Return a new string equal...
____
But do we really need to say this now, for every function?
In the past nondestructive was the default (implicit), and
we called out destructive exceptions.
I'm not saying we shouldn't, especially if it just means
adding a "new" here or there. But if descriptions aren't
somewhat consistent then we risk increasing confusion,
rather than diminishing it. If we go out of our way to
say here that the returned string is a new one, will we
start saying that everywhere?
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 16:49 ` Drew Adams
@ 2020-09-28 16:55 ` Eli Zaretskii
2020-09-28 17:11 ` Drew Adams
2020-09-28 17:44 ` John Yates
1 sibling, 1 reply; 23+ messages in thread
From: Eli Zaretskii @ 2020-09-28 16:55 UTC (permalink / raw)
To: Drew Adams; +Cc: mattiase, rpluim, emacs-devel, john
> Date: Mon, 28 Sep 2020 09:49:47 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: Mattias Engdegård <mattiase@acm.org>,
> Emacs developers <emacs-devel@gnu.org>
>
> > Okay. Then how about
> >
> > Return a string equal to @var{instring} with every occurence of
> > @var{fromstring} replaced by @var{tostring}.
>
> Return a new string equal...
The "equal" part is extremely confusing, IMNSHO. Why do we need it
here?
^ permalink raw reply [flat|nested] 23+ messages in thread
* RE: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 16:55 ` Eli Zaretskii
@ 2020-09-28 17:11 ` Drew Adams
2020-09-28 18:11 ` Eli Zaretskii
0 siblings, 1 reply; 23+ messages in thread
From: Drew Adams @ 2020-09-28 17:11 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: mattiase, rpluim, emacs-devel, john
> > > Okay. Then how about
> > >
> > > Return a string equal to @var{instring} with every occurence of
> > > @var{fromstring} replaced by @var{tostring}.
> >
> > Return a new string equal...
>
> The "equal" part is extremely confusing, IMNSHO. Why do we need it
> here?
What do you find extremely confusing about it?
I'm not the one who proposed that "equal" part, but
I'd say that it helps if we draw _some_ relation
between the returned string to INSTRING.
And the relation needs to express that (1) they
don't share structure and (2) they're equal except
for the specified diffs.
What do we mean by "equal", there? Predicate `equal'
(or `string-equal', if you prefer - they amount to
the same thing here).
We don't want to say "replace" presumably, as that
can suggest modification.
You can say "Return a string obtained by copying
INSTRING and replacing each occurrence of FROMSTRING
in that copy by TOSTRING" (which is long but can be
split). Mentioning copying means you don't have to
say "new".
Or you can say something else. But the point is:
(1) The returned string is obtained from INSTRING.
(2) The returned string is a new string (INSTRING
isn't modified).
(3) The returned string is equal to INSTRING, except
for the indicated differences.
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 16:49 ` Drew Adams
2020-09-28 16:55 ` Eli Zaretskii
@ 2020-09-28 17:44 ` John Yates
2020-09-29 13:40 ` Lars Ingebrigtsen
1 sibling, 1 reply; 23+ messages in thread
From: John Yates @ 2020-09-28 17:44 UTC (permalink / raw)
To: Drew Adams; +Cc: Mattias Engdegård, Robert Pluim, Emacs developers
Is it guaranteed to be new if no replacements happen?
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 17:11 ` Drew Adams
@ 2020-09-28 18:11 ` Eli Zaretskii
2020-09-28 22:36 ` John Yates
0 siblings, 1 reply; 23+ messages in thread
From: Eli Zaretskii @ 2020-09-28 18:11 UTC (permalink / raw)
To: Drew Adams; +Cc: mattiase, rpluim, emacs-devel, john
> Date: Mon, 28 Sep 2020 10:11:55 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: john@yates-sheets.org, rpluim@gmail.com, mattiase@acm.org,
> emacs-devel@gnu.org
>
> > > > Okay. Then how about
> > > >
> > > > Return a string equal to @var{instring} with every occurence of
> > > > @var{fromstring} replaced by @var{tostring}.
> > >
> > > Return a new string equal...
> >
> > The "equal" part is extremely confusing, IMNSHO. Why do we need it
> > here?
>
> What do you find extremely confusing about it?
The "equal" part.
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 18:11 ` Eli Zaretskii
@ 2020-09-28 22:36 ` John Yates
2020-09-28 22:47 ` Drew Adams
2020-09-29 2:37 ` Eli Zaretskii
0 siblings, 2 replies; 23+ messages in thread
From: John Yates @ 2020-09-28 22:36 UTC (permalink / raw)
To: Eli Zaretskii
Cc: Mattias Engdegård, Robert Pluim, Drew Adams,
Emacs developers
On Mon, Sep 28, 2020 at 2:12 PM Eli Zaretskii <eliz@gnu.org> wrote:
>
> > What do you find extremely confusing about it?
>
> The "equal" part.
Return a string equivalent to @var{instring} with every occurence
of @var{fromstring} replaced by @var{tostring}.
This has the virtue that it does not commit to returning a string
distinct from @var{instring} when there are no replacements.
Interesting that we are wordsmithing new and equals. Originally
I introduced this wording to solicit feedback on adopting the
imperative mood. Cohorts of git users are being taught to use
it. And as I stated in my first email, I find it emphasizes the
contractual aspect of an API.
/john
^ permalink raw reply [flat|nested] 23+ messages in thread
* RE: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 22:36 ` John Yates
@ 2020-09-28 22:47 ` Drew Adams
2020-09-29 2:35 ` Eli Zaretskii
2020-09-29 2:37 ` Eli Zaretskii
1 sibling, 1 reply; 23+ messages in thread
From: Drew Adams @ 2020-09-28 22:47 UTC (permalink / raw)
To: John Yates, Eli Zaretskii
Cc: Mattias Engdegård, Robert Pluim, Emacs developers
> > > What do you find extremely confusing about it?
> >
> > The "equal" part.
>
> Return a string equivalent to @var{instring} with every occurence
> of @var{fromstring} replaced by @var{tostring}.
"Equivalent" is unclear. In what way equivalent?
`equal' and `string-equal' are clear. They say just
what we mean here by "equivalent".
INSTRING and the returned string are `equal', modulo
the differences specified by FROMSTRING and TOSTRING.
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 22:47 ` Drew Adams
@ 2020-09-29 2:35 ` Eli Zaretskii
2020-09-29 4:28 ` Drew Adams
0 siblings, 1 reply; 23+ messages in thread
From: Eli Zaretskii @ 2020-09-29 2:35 UTC (permalink / raw)
To: Drew Adams; +Cc: mattiase, rpluim, emacs-devel, john
> Date: Mon, 28 Sep 2020 15:47:52 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: Robert Pluim <rpluim@gmail.com>,
> Mattias Engdegård
> <mattiase@acm.org>,
> Emacs developers <emacs-devel@gnu.org>
>
> INSTRING and the returned string are `equal', modulo
> the differences specified by FROMSTRING and TOSTRING.
So they are not equal, right?
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 22:36 ` John Yates
2020-09-28 22:47 ` Drew Adams
@ 2020-09-29 2:37 ` Eli Zaretskii
2020-09-29 7:12 ` Robert Pluim
1 sibling, 1 reply; 23+ messages in thread
From: Eli Zaretskii @ 2020-09-29 2:37 UTC (permalink / raw)
To: John Yates; +Cc: mattiase, rpluim, drew.adams, emacs-devel
> From: John Yates <john@yates-sheets.org>
> Date: Mon, 28 Sep 2020 18:36:24 -0400
> Cc: Drew Adams <drew.adams@oracle.com>, Robert Pluim <rpluim@gmail.com>,
> Mattias Engdegård <mattiase@acm.org>,
> Emacs developers <emacs-devel@gnu.org>
>
> On Mon, Sep 28, 2020 at 2:12 PM Eli Zaretskii <eliz@gnu.org> wrote:
> >
> > > What do you find extremely confusing about it?
> >
> > The "equal" part.
>
> Return a string equivalent to @var{instring} with every occurence
> of @var{fromstring} replaced by @var{tostring}.
Thanks, this is better. But "equivalent" is too vague to be useful.
What's wrong with the below? That's the natural way I'd say that.
Replace every occurrence of FROMSTRING with TOSTRING in INSTRING,
and return the result.
^ permalink raw reply [flat|nested] 23+ messages in thread
* RE: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 2:35 ` Eli Zaretskii
@ 2020-09-29 4:28 ` Drew Adams
2020-09-29 5:30 ` Eli Zaretskii
0 siblings, 1 reply; 23+ messages in thread
From: Drew Adams @ 2020-09-29 4:28 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: mattiase, rpluim, emacs-devel, john
> > INSTRING and the returned string are `equal', modulo
> > the differences specified by FROMSTRING and TOSTRING.
>
> So they are not equal, right?
Right. I don't think anyone said they were.
^ permalink raw reply [flat|nested] 23+ messages in thread
* RE: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 4:28 ` Drew Adams
@ 2020-09-29 5:30 ` Eli Zaretskii
2020-09-29 15:28 ` Drew Adams
0 siblings, 1 reply; 23+ messages in thread
From: Eli Zaretskii @ 2020-09-29 5:30 UTC (permalink / raw)
To: emacs-devel, Drew Adams; +Cc: mattiase, rpluim, john
On September 29, 2020 7:28:40 AM GMT+03:00, Drew Adams <drew.adams@oracle.com> wrote:
> > > INSTRING and the returned string are `equal', modulo
> > > the differences specified by FROMSTRING and TOSTRING.
> >
> > So they are not equal, right?
>
> Right. I don't think anyone said they were.
You suggested to use "equal" in the doc string for strings which we now agree are not equal. Such doc string would confusing.
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 2:37 ` Eli Zaretskii
@ 2020-09-29 7:12 ` Robert Pluim
2020-09-29 14:26 ` Eli Zaretskii
0 siblings, 1 reply; 23+ messages in thread
From: Robert Pluim @ 2020-09-29 7:12 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: mattiase, emacs-devel, drew.adams, John Yates
>>>>> On Tue, 29 Sep 2020 05:37:18 +0300, Eli Zaretskii <eliz@gnu.org> said:
>> From: John Yates <john@yates-sheets.org>
>> Date: Mon, 28 Sep 2020 18:36:24 -0400
>> Cc: Drew Adams <drew.adams@oracle.com>, Robert Pluim <rpluim@gmail.com>,
>> Mattias Engdegård <mattiase@acm.org>,
>> Emacs developers <emacs-devel@gnu.org>
>>
>> On Mon, Sep 28, 2020 at 2:12 PM Eli Zaretskii <eliz@gnu.org> wrote:
>> >
>> > > What do you find extremely confusing about it?
>> >
>> > The "equal" part.
>>
>> Return a string equivalent to @var{instring} with every occurence
>> of @var{fromstring} replaced by @var{tostring}.
Eli> Thanks, this is better. But "equivalent" is too vague to be useful.
Eli> What's wrong with the below? That's the natural way I'd say that.
Eli> Replace every occurrence of FROMSTRING with TOSTRING in INSTRING,
Eli> and return the result.
Thatʼs the 'imperative' version of what I originally proposed. I like
it.
Robert
--
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-28 17:44 ` John Yates
@ 2020-09-29 13:40 ` Lars Ingebrigtsen
2020-09-29 14:08 ` Mattias Engdegård
0 siblings, 1 reply; 23+ messages in thread
From: Lars Ingebrigtsen @ 2020-09-29 13:40 UTC (permalink / raw)
To: John Yates
Cc: Mattias Engdegård, Robert Pluim, Drew Adams,
Emacs developers
John Yates <john@yates-sheets.org> writes:
> Is it guaranteed to be new if no replacements happen?
Nope. It used to be, but it's unnecessary and more inefficient.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 13:40 ` Lars Ingebrigtsen
@ 2020-09-29 14:08 ` Mattias Engdegård
0 siblings, 0 replies; 23+ messages in thread
From: Mattias Engdegård @ 2020-09-29 14:08 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: Robert Pluim, Emacs developers, Drew Adams, John Yates
29 sep. 2020 kl. 15.40 skrev Lars Ingebrigtsen <larsi@gnus.org>:
>> Is it guaranteed to be new if no replacements happen?
>
> Nope. It used to be, but it's unnecessary and more inefficient.
The returned string is not guaranteed to be new even if replacements took place, for that matter.
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 7:12 ` Robert Pluim
@ 2020-09-29 14:26 ` Eli Zaretskii
2020-09-29 15:23 ` Robert Pluim
0 siblings, 1 reply; 23+ messages in thread
From: Eli Zaretskii @ 2020-09-29 14:26 UTC (permalink / raw)
To: Robert Pluim; +Cc: mattiase, emacs-devel, drew.adams, john
> From: Robert Pluim <rpluim@gmail.com>
> Cc: John Yates <john@yates-sheets.org>, drew.adams@oracle.com,
> mattiase@acm.org, emacs-devel@gnu.org
> Date: Tue, 29 Sep 2020 09:12:09 +0200
>
> Eli> What's wrong with the below? That's the natural way I'd say that.
>
> Eli> Replace every occurrence of FROMSTRING with TOSTRING in INSTRING,
> Eli> and return the result.
>
> Thatʼs the 'imperative' version of what I originally proposed. I like
> it.
Who did NOT like it, and why?
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 14:26 ` Eli Zaretskii
@ 2020-09-29 15:23 ` Robert Pluim
2020-09-29 16:02 ` Eli Zaretskii
0 siblings, 1 reply; 23+ messages in thread
From: Robert Pluim @ 2020-09-29 15:23 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: mattiase, john, drew.adams, emacs-devel
>>>>> On Tue, 29 Sep 2020 17:26:55 +0300, Eli Zaretskii <eliz@gnu.org> said:
>> From: Robert Pluim <rpluim@gmail.com>
>> Cc: John Yates <john@yates-sheets.org>, drew.adams@oracle.com,
>> mattiase@acm.org, emacs-devel@gnu.org
>> Date: Tue, 29 Sep 2020 09:12:09 +0200
>>
Eli> What's wrong with the below? That's the natural way I'd say that.
>>
Eli> Replace every occurrence of FROMSTRING with TOSTRING in INSTRING,
Eli> and return the result.
>>
>> Thatʼs the 'imperative' version of what I originally proposed. I like
>> it.
Eli> Who did NOT like it, and why?
Iʼm not going to go back over this already too long thread, but there
were various calls to have the word 'equal' appear, when my whole
starting point was that the result string would not be equal to the
original (except when it is :-))
Robert
--
^ permalink raw reply [flat|nested] 23+ messages in thread
* RE: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 5:30 ` Eli Zaretskii
@ 2020-09-29 15:28 ` Drew Adams
0 siblings, 0 replies; 23+ messages in thread
From: Drew Adams @ 2020-09-29 15:28 UTC (permalink / raw)
To: Eli Zaretskii, emacs-devel; +Cc: mattiase, rpluim, john
> > > So they are not equal, right?
> >
> > Right. I don't think anyone said they were.
>
> You suggested to use "equal" in the doc string
> for strings which we now agree are not equal.
> Such doc string would confusing.
We're going 'round and 'round.
As I said before, I am not the one who suggested
to use "equal":
I'm not the one who proposed that "equal" part
And the suggestions were _never_ to say that the
input and result strings are equal. It was to
say that the input string _with the changes
applied_ is equal (in fact `equal') to the
returned string. Which is true.
https://lists.gnu.org/archive/html/emacs-devel/2020-09/msg02159.html
I suggest you maybe reread what the suggestions were.
This incessant back & forth quibbling is tiring.
I'm done with this one.
^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598)
2020-09-29 15:23 ` Robert Pluim
@ 2020-09-29 16:02 ` Eli Zaretskii
0 siblings, 0 replies; 23+ messages in thread
From: Eli Zaretskii @ 2020-09-29 16:02 UTC (permalink / raw)
To: Robert Pluim; +Cc: mattiase, john, drew.adams, emacs-devel
> From: Robert Pluim <rpluim@gmail.com>
> Cc: mattiase@acm.org, emacs-devel@gnu.org, drew.adams@oracle.com,
> john@yates-sheets.org
> Date: Tue, 29 Sep 2020 17:23:58 +0200
>
> Eli> Who did NOT like it, and why?
>
> Iʼm not going to go back over this already too long thread, but there
> were various calls to have the word 'equal' appear, when my whole
> starting point was that the result string would not be equal to the
> original (except when it is :-))
Right.
I will let others voice objections, and will make the change if none
come up.
^ permalink raw reply [flat|nested] 23+ messages in thread
end of thread, other threads:[~2020-09-29 16:02 UTC | newest]
Thread overview: 23+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <20200927124520.25321.62354@vcs0.savannah.gnu.org>
[not found] ` <20200927124522.BA20F207E0@vcs0.savannah.gnu.org>
2020-09-28 9:42 ` master 583cb26 2/3: Improve accuracy in string-replace description (bug#43598) Robert Pluim
2020-09-28 9:59 ` Mattias Engdegård
2020-09-28 11:09 ` Robert Pluim
[not found] ` <CAJnXXojjUAcRVmsZNWQ2j9rSDv76Y0od4yWfVg11k-Q2tf4NYA@mail.gmail.com>
2020-09-28 13:50 ` Robert Pluim
2020-09-28 16:36 ` John Yates
2020-09-28 16:49 ` Drew Adams
2020-09-28 16:55 ` Eli Zaretskii
2020-09-28 17:11 ` Drew Adams
2020-09-28 18:11 ` Eli Zaretskii
2020-09-28 22:36 ` John Yates
2020-09-28 22:47 ` Drew Adams
2020-09-29 2:35 ` Eli Zaretskii
2020-09-29 4:28 ` Drew Adams
2020-09-29 5:30 ` Eli Zaretskii
2020-09-29 15:28 ` Drew Adams
2020-09-29 2:37 ` Eli Zaretskii
2020-09-29 7:12 ` Robert Pluim
2020-09-29 14:26 ` Eli Zaretskii
2020-09-29 15:23 ` Robert Pluim
2020-09-29 16:02 ` Eli Zaretskii
2020-09-28 17:44 ` John Yates
2020-09-29 13:40 ` Lars Ingebrigtsen
2020-09-29 14:08 ` Mattias Engdegård
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).