From 27145d24fe2d0d8037addc1aa30bf0112b58643e Mon Sep 17 00:00:00 2001 From: Hyewon Choi <76198373+hyew0nChoi@users.noreply.github.com> Date: Tue, 15 Oct 2024 23:20:42 +0900 Subject: [PATCH] Update CLI autocompletion docs with new Click syntax (#4213) * Update CLI autocompletion docs with new Click syntax Updated the autocompletion setup instructions for Bash, Zsh, and Fish shells to reflect the latest Click 8.1 syntax. Changed Fish shell completion script path to ~/.config/fish/completions/kedro.fish for correct placement. Signed-off-by: hyew0nChoi --- RELEASE.md | 4 ++++ docs/source/development/commands_reference.md | 6 +++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 59cace8a36..a5e34a6ba8 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -4,7 +4,10 @@ ## Bug fixes and other changes ## Breaking changes to the API ## Documentation changes +* Updated CLI autocompletion docs with new Click syntax. + ## Community contributions +* [Hyewon Choi](https://github.com/hyew0nChoi) # Release 0.19.9 @@ -38,6 +41,7 @@ * Fix logo on PyPI page. * Minor language/styling updates. + ## Community contributions * [Puneet](https://github.com/puneeter) * [ethanknights](https://github.com/ethanknights) diff --git a/docs/source/development/commands_reference.md b/docs/source/development/commands_reference.md index 12a90371f7..d66d4ffcc6 100644 --- a/docs/source/development/commands_reference.md +++ b/docs/source/development/commands_reference.md @@ -16,7 +16,7 @@ echo $0 Add the following to your ~/.bashrc (or just run it on the command line): ```bash -eval "$(_KEDRO_COMPLETE=source kedro)" +eval "$(_KEDRO_COMPLETE=bash_source kedro)" ``` @@ -26,7 +26,7 @@ eval "$(_KEDRO_COMPLETE=source kedro)" Add the following to ~/.zshrc: ```bash -eval "$(_KEDRO_COMPLETE=source_zsh kedro)" +eval "$(_KEDRO_COMPLETE=zsh_source kedro)" ``` @@ -36,7 +36,7 @@ eval "$(_KEDRO_COMPLETE=source_zsh kedro)" Add the following to ~/.config/fish/completions/foo-bar.fish: ```bash -eval (env _KEDRO_COMPLETE=source_fish kedro) +eval (env _KEDRO_COMPLETE=fish_source kedro) ```