Re: [PATCH] completion (zsh): fix misleading install location

From: Denton Liu <liu.denton@gmail.com>
Date: Jun 6, 2019, 22:44 UTC
Message-ID: <20190606224450.GA31942@archbookpro.localdomain>
In-Reply-To: <0102016b2ebafc26-1bd39076-62e4-4b7e-9309-b08cc072fbdf-000000@eu-west-1.amazonses.com>

Hi Durant,

Just a couple of small things:

On Thu, Jun 06, 2019 at 09:38:54PM +0000, Durant Schoon wrote:

Show 9 quoted lines

> When the code comment in the zsh completion suggests that this file
> should be copied to `~/.zsh`, many users might be misled to believe that
> this refers to a file location. But it refers to a directory, and won't
> work when it is a file.
> 
> Let's just add a slash, to make it abundantly clear that this must be a
> directory.
> 
> (thank you to Johannes Schindelin for the suggested wording and title)

Maybe this would be better incorporated as a Helped-by: or Suggested-by: tag at the bottom?

> 
> Signed-off-by: B. Durant Schoon durant.schoon@gmail.com

The email in your sign-off line should be wrapped in <>, i.e. it should be

	B. Durant Schoon <durant.schoon@gmail.com>

Other than that, the patch looks fine to me.

Thanks,

Denton

Show 22 quoted lines

> ---
>  contrib/completion/git-completion.zsh | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh
> index 886bf95d1f594..0e63004e2613e 100644
> --- a/contrib/completion/git-completion.zsh
> +++ b/contrib/completion/git-completion.zsh
> @@ -11,8 +11,8 @@
>  #
>  #  zstyle ':completion:*:*:git:*' script ~/.git-completion.zsh
>  #
> -# The recommended way to install this script is to copy to '~/.zsh/_git', and
> -# then add the following to your ~/.zshrc file:
> +# The recommended way to install this script is to copy to '~/.zsh/_git/',
> +# and then add the following to your ~/.zshrc file:
>  #
>  #  fpath=(~/.zsh $fpath)
>  
> 
> --
> https://github.com/git/git/pull/609