Skip to content

Commit d312eb5

Browse files
committed
Update fish shell documentation
Completions using a path must have the full path and be sourced in order to work correctly.
1 parent a2b8bc6 commit d312eb5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

contrib/README.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ or create new completion file, e.g::
1616

1717
register-python-argcomplete --shell fish my-awesome-script > ~/.config/fish/completions/my-awesome-script.fish
1818

19+
If the script is called using a path, such as ``./my-awesome-script``, it must be registered using the absolute path to the script.::
20+
21+
register-python-argcomplete --shell fish $(realpath ./my-awesome-script) > ~/.config/fish/completions/my-awesome-script.fish
22+
23+
The completions using a path will not be automatically loaded since the command name does not match the file name. To load the completetions, ``source`` them.::
24+
25+
source ~/.config/fish/completions/my-awesome-script.fish
26+
1927
Completion Description For Fish
2028
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2129
By default help string is added as completion description.

0 commit comments

Comments
 (0)