From: Junio C Hamano Date: Sun, 19 Jun 2011 22:51:34 GMT Subject: Re: [PATCH 2/6] Factorize shortening of notes refname for display. Message-ID: <7vliwxe8p5.fsf@alter.siamese.dyndns.org> In-Reply-To: <201106192325.00667.johan@herland.net> Johan Herland writes: > On Saturday 18 June 2011, Yann Dirson wrote: >> Signed-off-by: Yann Dirson >> --- >> notes.c | 24 ++++++++++++++++-------- >> notes.h | 7 +++++++ >> 2 files changed, 23 insertions(+), 8 deletions(-) >> >> [...] >> >> /* >> + * Return a short name for a notes ref, suitable for display to the user. >> + * >> + * No copy is done, the return value is a pointer into the original string. >> + */ >> +const char *notes_ref_shortname(const char *ref); >> + >> +/* > > Please include in the documentation what a NULL return means. > > Otherwise the patch looks OK. It may be just me, but every time somebody says Factorize, I find myself looking for math textbook from middle school days, 12 = 2 * 2 * 3, etc. Could we say Refactor instead pretty please?