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

G. Branden Robinson
2020-09-27T06:10:22Z

[-- Attachment #1: Type: text/plain, Size: 1366 bytes --]

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.

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]