git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Linus Arver <linusa@google.com>
To: Brian Lyles <brianmlyles@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] docs: correct trailer `key_value_separator` description
Date: Sun, 17 Mar 2024 23:29:35 -0700	[thread overview]
Message-ID: <owlyv85k2gts.fsf@fine.c.googlers.com> (raw)
In-Reply-To: <17bdc28ea2b88503.70b1dd9aae081c6e.203dcd72f6563036@zivdesk>

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

> 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

  reply	other threads:[~2024-03-18  6:29 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-16  3:55 [PATCH] docs: correct trailer `key_value_separator` description Brian Lyles
2024-03-16  6:53 ` Linus Arver
2024-03-18  4:49   ` Brian Lyles
2024-03-18  6:29     ` Linus Arver [this message]
2024-03-18 16:02       ` Junio C Hamano
2024-03-18 18:15         ` Kristoffer Haugsbakk
2024-03-18 19:13           ` Junio C Hamano
2024-03-19  7:21         ` Linus Arver
2024-03-18  5:38 ` [PATCH v2 1/2] " Brian Lyles
2024-03-18 16:34   ` Junio C Hamano
2024-03-18  5:38 ` [PATCH v2 2/2] docs: adjust trailer `separator` and `key_value_separator` language Brian Lyles
2024-03-18  6:42   ` Linus Arver

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=owlyv85k2gts.fsf@fine.c.googlers.com \
    --to=linusa@google.com \
    --cc=brianmlyles@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).