zsh-workers
 help / color / mirror / Atom feed
* [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion
@ 2021-04-19 17:29 Marlon Richert
  2021-04-20 21:36 ` Daniel Shahaf
  0 siblings, 1 reply; 4+ messages in thread
From: Marlon Richert @ 2021-04-19 17:29 UTC (permalink / raw)
  To: Zsh hackers list

[-- Attachment #1: Type: text/plain, Size: 43 bytes --]

…and hide mutually exclusive options.


[-- Attachment #2: 0001-Add-L-to-add-zsh-zle-hook-widget-completion.txt --]
[-- Type: text/plain, Size: 2646 bytes --]

From 8b0221296db36c4d55d1b99577886f72afd76d3b Mon Sep 17 00:00:00 2001
From: Marlon Richert <marlon.richert@gmail.com>
Date: Mon, 19 Apr 2021 20:24:36 +0300
Subject: [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

…and hide mutually exclusive options.
---
 Completion/Zsh/Function/_add-zle-hook-widget | 9 ++++++---
 Completion/Zsh/Function/_add-zsh-hook        | 9 ++++++---
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/Completion/Zsh/Function/_add-zle-hook-widget b/Completion/Zsh/Function/_add-zle-hook-widget
index f108d1868..c0bd77819 100644
--- a/Completion/Zsh/Function/_add-zle-hook-widget
+++ b/Completion/Zsh/Function/_add-zle-hook-widget
@@ -26,9 +26,12 @@ _add-zle-hook-widget() {
   local context state state_descr line
   typeset -A opt_args
   _arguments -s -w -S : \
-    '(-D)-d[remove HOOK from the array]' \
-    '(-d)-D[interpret HOOK as pattern to remove from the array]' \
-    {-U,-z,-k}"[passed to 'autoload']" \
+    "(-d -D -U -z -k)-L[output in form of 'zstyle' commands]" \
+    '(-L -D -U -z -k)-d[remove HOOK from the array]' \
+    '(-L -d -U -z -k)-D[interpret HOOK as pattern to remove from the array]' \
+    '(-L -d -D)-U[suppress alias expansion for functions]' \
+    '(-L -d -D -k)-z[mark function for zsh-style autoloading]' \
+    '(-L -d -D -z)-k[mark function for ksh-style autoloading]' \
     ':hook type:_add-zle-hook-widget_types' \
     ':widget:_add-zle-hook-widget_widgets'
 }
diff --git a/Completion/Zsh/Function/_add-zsh-hook b/Completion/Zsh/Function/_add-zsh-hook
index e8ae97052..4d8a96dab 100644
--- a/Completion/Zsh/Function/_add-zsh-hook
+++ b/Completion/Zsh/Function/_add-zsh-hook
@@ -14,9 +14,12 @@ _add-zsh-hook() {
   local context state state_descr line
   typeset -A opt_args
   _arguments -s -w -S : \
-    '(-D)-d[remove HOOK from the array]' \
-    '(-d)-D[interpret HOOK as pattern to remove from the array]' \
-    {-U,-z,-k}"[passed to 'autoload']" \
+    "(-d -D -U -z -k)-L[output in form of 'typeset' commands]" \
+    '(-L -D -U -z -k)-d[remove HOOK from the array]' \
+    '(-L -d -U -z -k)-D[interpret HOOK as pattern to remove from the array]' \
+    '(-L -d -D)-U[suppress alias expansion for functions]' \
+    '(-L -d -D -k)-z[mark function for zsh-style autoloading]' \
+    '(-L -d -D -z)-k[mark function for ksh-style autoloading]' \
     ':hook class:(chpwd precmd preexec periodic zshaddhistory zshexit zsh_directory_name)' \
     ':hook function:_add-zsh-hook_hooks'
 }
-- 
2.31.1


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion
  2021-04-19 17:29 [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion Marlon Richert
@ 2021-04-20 21:36 ` Daniel Shahaf
  2021-04-21  5:59   ` Marlon Richert
  0 siblings, 1 reply; 4+ messages in thread
From: Daniel Shahaf @ 2021-04-20 21:36 UTC (permalink / raw)
  To: Marlon Richert; +Cc: Zsh hackers list

> From 8b0221296db36c4d55d1b99577886f72afd76d3b Mon Sep 17 00:00:00 2001
> From: Marlon Richert <marlon.richert@gmail.com>
> 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.

Cheers,

Daniel


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion
  2021-04-20 21:36 ` Daniel Shahaf
@ 2021-04-21  5:59   ` Marlon Richert
  2021-04-21 20:01     ` Daniel Shahaf
  0 siblings, 1 reply; 4+ messages in thread
From: Marlon Richert @ 2021-04-21  5:59 UTC (permalink / raw)
  To: Daniel Shahaf; +Cc: Zsh hackers list

On 21 Apr 2021, at 00:36, Daniel Shahaf <d.s@daniel.shahaf.name> wrote:
> 
>> From 8b0221296db36c4d55d1b99577886f72afd76d3b Mon Sep 17 00:00:00 2001
>> From: Marlon Richert <marlon.richert@gmail.com>
>> 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). But point taken; I will spell it out next time, if not in the first line, then at least in an additional line.

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

diff --git a/ChangeLog b/ChangeLog
index 7cf9ec4e5..079b92d32 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2021-04-19  Oliver Kiddle  <opk@zsh.org>
 
+   * Marlon Richert: 48621: Completion/Zsh/Function/_add-zsh-hook,
+   Completion/Zsh/Function/_add-zle-hook-widget: Add -L to
+   add-(zsh|zle)-hook[-widget] completion
+
        * André Kugland: github/zsh-completions #792:
        Completion/Unix/Command/_opustools: new opus-tools completion
 



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion
  2021-04-21  5:59   ` Marlon Richert
@ 2021-04-21 20:01     ` Daniel Shahaf
  0 siblings, 0 replies; 4+ messages in thread
From: Daniel Shahaf @ 2021-04-21 20:01 UTC (permalink / raw)
  To: Marlon Richert; +Cc: Zsh hackers list

Marlon Richert wrote on Wed, Apr 21, 2021 at 08:59:22 +0300:
> On 21 Apr 2021, at 00:36, Daniel Shahaf <d.s@daniel.shahaf.name> wrote:
> > 
> >> From 8b0221296db36c4d55d1b99577886f72afd76d3b Mon Sep 17 00:00:00 2001
> >> From: Marlon Richert <marlon.richert@gmail.com>
> >> 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_)


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2021-04-21 20:02 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-19 17:29 [PATCH] Add -L to add-(zsh|zle)-hook[-widget] completion Marlon Richert
2021-04-20 21:36 ` Daniel Shahaf
2021-04-21  5:59   ` Marlon Richert
2021-04-21 20:01     ` Daniel Shahaf

zsh-workers

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.vuxu.org/zsh-workers

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 zsh-workers zsh-workers/ http://inbox.vuxu.org/zsh-workers \
		zsh-workers@zsh.org
	public-inbox-index zsh-workers

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.archive.zsh.workers


code repositories for the project(s) associated with this inbox:

	https://git.vuxu.org/mirror/zsh/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git