Re: [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion

[Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx>]

Marlon Richert wrote on Wed, Apr 21, 2021 at 08:59:22 +0300:
> On 21 Apr 2021, at 00:36, Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx> wrote:
> > 
> >> From 8b0221296db36c4d55d1b99577886f72afd76d3b Mon Sep 17 00:00:00 2001
> >> From: Marlon Richert <marlon.richert@xxxxxxxxx>
> >> Date: Mon, 19 Apr 2021 20:24:36 +0300
> >> Subject: [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion
> > 
> > The patch has already been merged, but still:
> > 
> > Symbols names should be able to be grepped for, so please don't hide
> > them behind glob patterns.
> 
> Ah, you mean in the commit message? Fair enough. I was just trying to
> keep the first line of the commit message to 50 characters or less, in
> line with [Git’s
> recommendations](https://book.git-scm.com/docs/git-commit#_discussion).

We don't follow the 50-character convention too closely:

% git log origin --pretty='%s <%aN>' | grep -v Shahaf | cut -d\< -f1 | cut -c51- | head -1000 > >(wc -l) > >(grep . | wc -l) > /dev/null 
1000
503
% 

> But point taken; I will spell it out next time, if not in the first
> line, then at least in an additional line.
> 

Yeah, mentioning it in expanded form once is generally enough to make
them greppable.

Abbreviating further mentions is a separate question.  It may be helpful
in some cases, but not in every case.  One should know when not to use
a given hammer.

Symbol names should also be mentioned greppably in ChangeLog, and
abbreviating them in the first line may conflict with that, since the
first line and the ChangeLog message are often similar.  (My git-am(1)
wrapper scripts use the first line as the ChangeLog message verbatim.)

> In any case, Oliver did add the exact function names to Changelog:

Indeed.  If that hadn't been the case, I'd have edited ChangeLog to
retroactively expand the acronym.

Daniel
(who's reminded of Heinlein's _Tunnel in the Sky_)