From f6212f733068be15a5c35d8076012ec959582e0f Mon Sep 17 00:00:00 2001 From: Sam Doran Date: Tue, 12 Aug 2025 16:07:16 -0400 Subject: [PATCH] Update fish shell documentation Completions using a path must have the full path and be sourced in order to work correctly. --- contrib/README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/contrib/README.rst b/contrib/README.rst index 25af998c..c1309626 100644 --- a/contrib/README.rst +++ b/contrib/README.rst @@ -16,6 +16,14 @@ or create new completion file, e.g:: register-python-argcomplete --shell fish my-awesome-script > ~/.config/fish/completions/my-awesome-script.fish +If the script is called using a path, such as ``./my-awesome-script``, it must be registered using the absolute path to the script. :: + + register-python-argcomplete --shell fish $(realpath ./my-awesome-script) > ~/.config/fish/completions/my-awesome-script.fish + +The completions using a path will not be automatically loaded since the command name does not match the file name. To load the completions, ``source`` them. :: + + source ~/.config/fish/completions/my-awesome-script.fish + Completion Description For Fish ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ By default help string is added as completion description.