Re: [PATCH] docs: correct trailer `key_value_separator` description

From: Linus Arver <linusa@google.com>
Date: Mar 18, 2024, 06:29 UTC
Message-ID: <owlyv85k2gts.fsf@fine.c.googlers.com>
In-Reply-To: <17bdc28ea2b88503.70b1dd9aae081c6e.203dcd72f6563036@zivdesk>

"Brian Lyles" <brianmlyles@gmail.com> writes:

Show 10 quoted lines

> Hi Linus
>
> On Sat, Mar 16, 2024 at 1:53 AM Linus Arver <linusa@google.com> wrote:
>
>> Nit: This line was modified to have " each" at the end. If you did that
>> on the next line, then this diff could have been a touch smaller.
>
> [...] Is there a documented guideline to follow here, both in
> terms of preferred wrap width as well as when it might be appropriate to
> stray from it for reasons such as this?

WRT line lengths, probably 80-ish columns is the (unwritten?) rule. The text files aren't really meant for end-user consumption (that's what the manpage and HTML formats are for), so I think it's OK if the line lengths are roughly in the same ballpark (no need to worry too much about exact lengths).

When I contributed some patches to the docs last year, I was advised to minimize diffs where appropriate, to make it easier for reviewers. In this case it didn't matter too much (the patch being so small), but I thought it was still worth mentioning. /shrug