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: Fri, 19 May 2017 21:23:57 +0900

>> ===========================
>> Improve documentation of (split-string)
>> 
>> * /doc/lispref/strings.texi (split-string): change paragraph
>>  order to improve readability.
>> ===========================
> 
> Thanks, pushed.
> 
> 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.
>> ===========================


JC





reply via email to

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