|
From: | Paul Eggert |
Subject: | Re: When will emacs 27.1 be officially released? |
Date: | Thu, 2 Jul 2020 13:36:05 -0700 |
User-agent: | Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.8.0 |
On 7/2/20 1:29 PM, Tassilo Horn wrote: > I just looked at the docs and it seems that in large parts the > function descriptions in the manual read > > This function takes a @var{coin} and returns a @var{beer}. > > (indicative) whereas the docstring reads > > Take a COIN and return a BEER. > > (imperative). I know the latter is our convention for function > docstrings. Is the former our convention for documenting functions in > the manual? Yes but I'd rather we switched to imperative, for consistency and brevity.
[Prev in Thread] | Current Thread | [Next in Thread] |