From: Thomas Rast <trast@student.ethz.ch>
Date: Tue, 04 May 2010 07:09:42 GMT
Subject: Re: [PATCH 4/4] Documentation/notes: nitpicks
Message-ID: <201005040909.43247.trast@student.ethz.ch>
In-Reply-To: <20100503234720.GD27483@progeny.tock>

Jonathan Nieder wrote:
> -A typical use of notes is to extend a commit message without having
> -to change the commit itself. Such commit notes can be shown by `git log`
> -along with the original commit message. To discern these notes from the
> +A typical use of notes is to supplement a commit message without
> +changing the commit itself. Notes can be shown by 'git log' along with
> +the original commit message. To distinguish these notes from the
>  message stored in the commit object, the notes are indented like the
>  message, after an unindented line saying "Notes (<refname>):" (or
> -"Notes:" for the default setting).
> +"Notes:" for the main notes ref).

Nitpick on your nitpick: we do not call refs/notes/commits the "main"
notes ref anywhere, and you don't seem to introduce this terminology.

The user might infer that "main" means core.notesRef, but the omission
of (<refname>) is actually hardcoded to only happen for
refs/notes/commits, so that's not correct.


[I'll review the other patches after the lecture.]

-- 
Thomas Rast
trast@{inf,student}.ethz.ch