From: Jean-Noël Avila <jn.avila@free.fr>
Date: Mon, 31 Jan 2022 13:36:07 GMT
Subject: Re: [PATCH v3 4/4] i18n: transfer variables into placeholders in command synopsis
Message-ID: <b8ff5544-6565-79f7-ee1e-0b53fefef94a@free.fr>
In-Reply-To: <3a12de6d-48f6-b1c1-4fca-655c0db648c7@gmail.com>

Le 31/01/2022 à 12:00, Phillip Wood a écrit :
> On 30/01/2022 22:01, Jean-Noël Avila via GitGitGadget wrote:
>> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
>>
>> This applies the style guide for documentation.
> 
> I don't really understand the title of this patch. Should 'transfer' be 
> 'transform'? All the changes look fine but seem to be two sorts of 
> changes mixed together
>   - adding '<>' around arguments where they are missing
>   - converting plurals followed by '...' into singulars followed by '...'
> 
> Best Wishes
> 
> Phillip
> 

TBH, this patch is a remaining of some changes performed while making 
the preceding one. They are the places that were false positive from the 
grep.

Fair enough, the changes are a little broader than advertised.

As for the plural forms transformed into singular forms, the coding 
guidelines is clear about repeated parameters of the same type, (e.g. 
<file>...), but some subsets of parameters are still preserved with 
plural, such as <options>, in which case they are not "atomic" (they may 
provide several cells in argv). This is not formalized atm.

My heuristic is that when the subset is not an array of a given type, 
but may be a collection of different types, we keep the plural. Maybe 
using another syntax for these "sub-expressions", along with a link to 
where to find them would help.


JN