Re: [PATCH v2 1/5] config doc: don't describe *.fetchObjects twice

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 25, 2018, 21:07 UTC
Message-ID: <CAPig+cTK1iKiYnxCH5D2RnhZxaNocgx9UuNeakxzf4LgFSnd9Q@mail.gmail.com>
In-Reply-To: <20180525192811.25680-2-avarab@gmail.com>

On Fri, May 25, 2018 at 3:28 PM, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:

> Let's not duplicate the description of what *.fsckObjects does twice.

Nit: "duplicate" and "twice" smell redundant.

> instead let's refer to transfer.fsckObjects from both fetch.* and
> receive.*.

s/instead/Instead/

Perhaps the above paragraph can be rewritten:

    Refer readers of fetch.fsckObjects and receive.fsckObjects to
    transfer.fsckObjects instead of repeating the description at each
    location.

(Not at all worth a re-roll.)

Show 5 quoted lines

> I don't think this description of it makes much sense, but for now I'm
> just moving the existing documentation around. Making it better will
> be done in a later patch.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>