[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Lowercase in section names
From: |
Ingo Schwarze |
Subject: |
Re: Lowercase in section names |
Date: |
Fri, 28 Apr 2023 19:23:27 +0200 |
Hi Alejandro,
Alejandro Colomar wrote on Fri, Apr 28, 2023 at 04:57:49PM +0200:
> I got a lot of warnings due to using lowercase in section headings.
> I remember we agreed to transition to true case in the title, but
> don't remember if we reached the same agreement in section headings.
>
> Do you agree to not use uppercase in section headings unnecessarily?
> The rationale is more or less the same as in the title: not discard
> information.
Plus better accessibility for people using screen readers.
> We already have bold for giving it more importance.
>
> Anyway, here goes my little complain:
>
> mandoc: man8/unitd.8:6:2: WARNING: first section is not "NAME": Sh Name
> mandoc: man8/unitd.8:8:2: WARNING: description line outside NAME section: Nd
> mandoc: man8/unitd.8:9:2: WARNING: first section is not "NAME": Sh Synopsis
> mandoc: man8/unitd.8:21:2: WARNING: first section is not "NAME": Sh
> Description
> mandoc: man8/unitd.8:28:2: WARNING: first section is not "NAME": Sh Options
> mandoc: man8/unitd.8:55:2: WARNING: first section is not "NAME": Sh Exit
> status
> mandoc: man8/unitd.8:57:2: WARNING: first section is not "NAME": Sh Files
> mandoc: man8/unitd.8:64:2: WARNING: first section is not "NAME": Sh Sockets
> mandoc: man8/unitd.8:69:2: WARNING: first section is not "NAME": Sh Copyright
> mandoc: man8/unitd.8:73:2: WARNING: first section is not "NAME": Sh See also
>
> Okay, I can understand the first two, and I can easily grep them away,
I certainly intend to add support for mixed-case section names to mandoc.
The work merely isn't done yet.
> but does mandoc(1) really need to remind me about that minor
> thing at every section? :P
No, that looks like a bug to me. Thanks for reporting!
Yours,
Ingo