Re: [PATCH 1/2] system_data_types.7: srcfix

Alejandro Colomar
2020-09-27T20:24:23Z

Hi Branden,

On 2020-09-27 08:10, G. Branden Robinson wrote:
> At 2020-09-25T10:03:30+0200, Alejandro Colomar wrote:
>> @@ -454,7 +454,7 @@ Used for a count of elements, and array indices.
>> It is the result of subtracting two pointers.
>> According to the C language standard, it shall be a signed integer
type
>> capable of storing values in the range
>> -.BR "" [ PTRDIFF_MIN ,
>> +.RB [ PTRDIFF_MIN ,
>> .BR PTRDIFF_MAX ].
>> .IP
>> The length modifier for
>
> Ooh, thanks for that. The deleted line is a terrible anti-pattern and
> you're doing everyone a solid by removing the temptation to copy it.

Yup, I introduced that line a few patches ago because
I didn't know .RB existed :)

BTW, thanks for all your comments.
Thanks to them I improved the style in system_data_types.7,
which I started a few weeks ago.

Thanks,

Alex

>
> groff_man_style(7) attempts to lead people to the light:
>
> Optional macro arguments are indicated by surrounding them with square
> brackets. If a macro accepts multiple arguments, those containing
> space characters must be double-quoted to be interpreted correctly. An
> empty macro argument can be specified with a pair of double-quotes
> (“""”), but the man package is designed such that this should seldom be
> necessary. Unused macro arguments are more often simply omitted, or
> good style suggests that a more appropriate macro be chosen, that ear‐
> lier arguments are more important than later ones, or that arguments
> have identical significance such that skipping any is superfluous.
>
> ...but alas, groff 1.22.5, or 1.23 or whatever we call it, is not yet
> released.
>
> Regards,
> Branden
>