Re: [PATCH 1/1] doc: Change zsh git completion file name

Johannes Schindelin [off-list ref] writes:

On Thu, 10 Oct 2019, Maxim Belsky via GitGitGadget wrote:

quoted

From: Maxim Belsky <redacted>

Signed-off-by: Maxim Belsky <redacted>

I totally agree with the patch, but only because I read a couple of
reports that users were struggling with this. Maybe add a couple of
reference points to the commit message, to describe how easy it is to
miss the fact that it needs to be a _file_, not a directory, and also
describe how `zsh` tells you that there is a problem (even if it does
not report a problem, that's a valuable piece of information for the
commit message).

After reading the updated text, and then hearing many people cannot
get if the existing reference to ~/.zsh/_git is about a directory
(to which this should be added as one of the files in it) or a file,
I doubt that the updated text is clear enough for these people.

quoted

-# 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-completion.zsh', and then add the following to your ~/.zshrc
+# file:

Perhaps making it absolutely clear by risking to be overly verbose,
like so?

    The recommended way to install this script is to make a copy of it
    in ~/.zsh/ directory as ~/.zsh/git-completion.zsh and then ...

If my attempt to be overly verbose and absolutely clear above is
giving a wrong piece of advice, then that would be an indication
that the original nor the updated text is clear enough, as they are
the primary sources of information on this matter I used to come up
with the suggestion ;-)

quoted

 #
 #  fpath=(~/.zsh $fpath)

--
gitgitgadget