Skip to content

Commit

Permalink
Update CLI autocompletion docs with new Click syntax (#4213)
Browse files Browse the repository at this point in the history
* 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 <statistic9935@naver.com>
  • Loading branch information
hyew0nChoi authored Oct 15, 2024
1 parent 5ad7775 commit 27145d2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/source/development/commands_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ echo $0
Add the following to your <code>~/.bashrc</code> (or just run it on the command line):

```bash
eval "$(_KEDRO_COMPLETE=source kedro)"
eval "$(_KEDRO_COMPLETE=bash_source kedro)"
```
</details>

Expand All @@ -26,7 +26,7 @@ eval "$(_KEDRO_COMPLETE=source kedro)"
Add the following to <code>~/.zshrc</code>:

```bash
eval "$(_KEDRO_COMPLETE=source_zsh kedro)"
eval "$(_KEDRO_COMPLETE=zsh_source kedro)"
```
</details>

Expand All @@ -36,7 +36,7 @@ eval "$(_KEDRO_COMPLETE=source_zsh kedro)"
Add the following to <code>~/.config/fish/completions/foo-bar.fish</code>:

```bash
eval (env _KEDRO_COMPLETE=source_fish kedro)
eval (env _KEDRO_COMPLETE=fish_source kedro)
```
</details>

Expand Down

0 comments on commit 27145d2

Please sign in to comment.