bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#26925: Improve /doc/lispref/strings.texi (split-string) documentatio


From: Jean-Christophe Helary
Subject: bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation
Date: Sat, 3 Jun 2017 17:50:27 +0900

Just one tiny bit of cleanup:

-If the optional argument @var{trim}
→
+If @var{trim}

just to adapt the text to the description of the other arguments.

===========================
Improve documentation of 'split-string'

 * doc/lispref/strings.texi (Creating Strings): Correct a wording in 
`split-string'.
===========================

Attachment: strings.texi.diff
Description: Binary data

> On 2017/05/19, at 22:30, Stephen Berman <address@hidden> wrote:
> 
> On Fri, 19 May 2017 15:56:41 +0300 Eli Zaretskii <address@hidden> wrote:
> 
>>> From: Jean-Christophe Helary <address@hidden>
>>> Date: Fri, 19 May 2017 21:23:57 +0900
>>> Cc: address@hidden
>>> 
>>>> One nit: please don't refer to functions with syntax that looks like a
>>>> function call, as in (split-string) above, or foo() for C sources.
>>>> The GNU Coding Standards frown on such references, because they look
>>>> like a call to a function with no arguments, which is not what is
>>>> meant there.  We use 'split-string' and 'foo' instead, i.e. the name
>>>> of the function in quotes.
>>> 
>>> Thank you Eli.
>>> 
>>> So the function name should have been quoted in both occurrences?
>>> 
>>>>> ===========================
>>>>> Improve documentation of 'split-string'
>>>>> 
>>>>> * /doc/lispref/strings.texi 'split-string': change paragraph
>>>>> order to improve readability.
>>>>> ===========================
>> 
>> No, only in the first occurrence.  In the ChangeLog-style entries, we
>> always put function names in parentheses.
> 
> Yes for code ChangeLogs, but for the Texinfo sources, the convention for
> ChangeLog entries seems to be to put the node name in parentheses, and
> then the function name would be quoted in the entry, as usual, e.g.:
> 
>    * doc/lispref/strings.texi (Creating Strings): Change paragraph
>      order of `split-string' definition to improve readability.
> 
> This convention of putting the node name in parens is apparently
> undocumented, but it's what `C-x 4 a' does and (probably that's why)
> almost all the ChangeLog entries for the Texinfo sources follow it.
> 
> Steve Berman


reply via email to

[Prev in Thread] Current Thread [Next in Thread]