Re: imperative vs. descriptive style

2018-05-07 Thread Bruno Haible
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 document

Re: Re: imperative vs. descriptive style

2018-05-07 Thread John W. Eaton
On 05/06/2018 10:33 AM, Jim Meyering wrote: Here's the relevant section: (from https://www.gnu.org/prep/standards/html_node/GNU-Manuals.html) Whenever possible, please stick to the active voice, avoiding the passive, and use the present tense, not the future teste. For instance, write “The funct

Re: imperative vs. descriptive style

2018-05-06 Thread Jim Meyering
On Sun, May 6, 2018 at 3:11 AM, Paul Eggert wrote: > Bruno Haible wrote: > >> The GNU Coding Standards [1] don't favour either, although I have vague >> memories that 20 years ago, it advocated imperative style. > > > Yes, I have the same vague memory, and still prefer imperative style in many > c

Re: imperative vs. descriptive style

2018-05-06 Thread Paul Eggert
Bruno Haible wrote: The GNU Coding Standards [1] don't favour either, although I have vague memories that 20 years ago, it advocated imperative style. Yes, I have the same vague memory, and still prefer imperative style in many cases. For routine use in comments, the imperative style is typic

Re: imperative vs. descriptive style

2018-05-06 Thread Bruno Haible
Hi Paul, > * lib/af_alg.h: Use imperatives and tighten up wording. > ... > -/* Computes a message digest of the contents of a file. > +/* Compute a message digest of the contents of a file. > ... > - If successful, this function fills RESBLOCK and returns 0. > - Upon failure, it returns a nega