[Top][All Lists]

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

Re: imperative vs. descriptive style

From: Bruno Haible
Subject: Re: imperative vs. descriptive style
Date: Mon, 07 May 2018 16:57:39 +0200
User-agent: KMail/5.1.3 (Linux/4.4.0-119-generic; KDE/5.18.0; x86_64; ; )

John W. Eaton wrote:
> I also have the vague recollection of RMS telling people to write
>    Return a list containing a and b.
> instead of
>    The function foo returns ...
> or even
>    Returns a list ...

He apparently doesn't do this any more. Recently RMS reviewed the
documentation of GNU libunistring [1]. He suggested to avoid passive voice.
But although this documentation uses the descriptive style ("Returns the ...")
consistently, he did not suggest to change that.


[1] https://www.gnu.org/software/libunistring/manual/libunistring.html

reply via email to

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