Re: *.m4 conventions

[Paul Eggert]

On 2024-05-13 09:57, Bruno Haible wrote:
> Note that in Gnulib, a human-readable comment
>    # Autoconf macros for the stdio module.
> is just as trivial as this comment:
>    # stdio_h.m4

Although that's true for experts, it's not necessarily true for 
beginners who are the main audience for the first line. A beginner won't 
know whether stdio_h.m4 is for the entire stdio module, or just for 
configuring the stdio.h replacement, or just for configuring the stdio 
implementation, or something else.

In general the first line could be quite helpful for a brief explanation 
of file contents, for non experts. Yes, this information can be put 
elsewhere in the .m4 file, but the first line is a better place for it.