Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CLI autocompletion docs with new Click syntax #4213

Merged
merged 6 commits into from
Oct 15, 2024

Conversation

hyew0nChoi
Copy link
Contributor

Description

Updated the autocompletion setup instructions for Bash, Zsh, and Fish shells to reflect the latest Click 8.1 syntax.

Development notes

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

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: HyeWon Choi <76198373+hyew0nChoi@users.noreply.github.com>
Signed-off-by: hyew0nChoi <statistic9935@naver.com>
@hyew0nChoi hyew0nChoi marked this pull request as ready for review October 7, 2024 14:43
@merelcht merelcht linked an issue Oct 7, 2024 that may be closed by this pull request
@merelcht merelcht added the Hacktoberfest Issue suitable for hacktoberfest label Oct 7, 2024
Copy link
Contributor

@ankatiyar ankatiyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @hyew0nChoi!

@hyew0nChoi
Copy link
Contributor Author

Review plz! @merelcht

Copy link
Contributor

@ElenaKhaustova ElenaKhaustova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @hyew0nChoi!

@hyew0nChoi
Copy link
Contributor Author

Thank you everyone for the reviews and approvals! 😊
Looking forward to the merge when you're ready. I really appreciate all the support.

@merelcht
Copy link
Member

@hyew0nChoi Can you add your name to the contributor list in the release notes? It should go under the "upcoming release" section. Then this is ready for merging 🙂

hyew0nChoi and others added 2 commits October 15, 2024 22:35
Signed-off-by: hyew0nChoi <statistic9935@naver.com>
@hyew0nChoi hyew0nChoi force-pushed the update-cli-autocompletion-docs branch from 09f4ad8 to bd9caa2 Compare October 15, 2024 14:04
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
@merelcht merelcht enabled auto-merge (squash) October 15, 2024 14:09
@hyew0nChoi
Copy link
Contributor Author

Thank you so much, @merelcht for your help 😊👍🏻

@merelcht merelcht merged commit 27145d2 into kedro-org:main Oct 15, 2024
7 of 8 checks passed
ankatiyar pushed a commit that referenced this pull request Oct 17, 2024
* 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>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
ankatiyar added a commit that referenced this pull request Oct 18, 2024
* Update index.md (#4221)

Fixed an erroneous link to the Get started with Kedro - Create your first data pipeline with Kedro video.  It was accidentally linked to the previous video.

Signed-off-by: Greg Vaslowski <7269272+Vaslo@users.noreply.github.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Bump kedro-sphinx-theme from 2024.4.0 to 2024.10.0 (#4216)

* Bump kedro-sphinx-theme from 2024.4.0 to 2024.10.0

Bumps [kedro-sphinx-theme](https://github.com/kedro-org/kedro-sphinx-theme) from 2024.4.0 to 2024.10.0.
- [Release notes](https://github.com/kedro-org/kedro-sphinx-theme/releases)
- [Commits](kedro-org/kedro-sphinx-theme@v2024.4.0...v2024.10.0)

---
updated-dependencies:
- dependency-name: kedro-sphinx-theme
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* updated to 2024.10.2

* trigger_run

* trigger_run

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: L. R. Couto <57910428+lrcouto@users.noreply.github.com>
Co-authored-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Replace all instances of "data set" with "dataset" (#4211)

Signed-off-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Manually created sitemap.xml for improved control over indexed docs pages (#4145)

* Load manually created sitemap

Signed-off-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>

* Add projects remove lastmod for latest

Signed-off-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>

* Add latest for projects

Signed-off-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>

---------

Signed-off-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>
Co-authored-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>
Co-authored-by: ElenaKhaustova <157851531+ElenaKhaustova@users.noreply.github.com>
Co-authored-by: L. R. Couto <57910428+lrcouto@users.noreply.github.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Bump up version to 0.19.9 (#4219)

* Bump up version to 0.19.9

Signed-off-by: Laura Couto <laurarccouto@gmail.com>

* Add placeholders to release.md

Signed-off-by: Laura Couto <laurarccouto@gmail.com>

* Update citation.cff release date

Signed-off-by: Laura Couto <laurarccouto@gmail.com>

---------

Signed-off-by: Laura Couto <laurarccouto@gmail.com>
Signed-off-by: L. R. Couto <57910428+lrcouto@users.noreply.github.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* first pass doesn't work yet

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update ocl tests

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* revert some changes

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update to use larger config

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update functions and docstrings

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Add performance tests for DataCatalog

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update mypy ignore messages (#4228)

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Revise Kedro project structure docs (#4208)

* Update project structure docs
---------

Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com>
Signed-off-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* 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 <statistic9935@naver.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Bump import-linter from 2.0 to 2.1 (#4226)

Bumps [import-linter](https://github.com/seddonym/import-linter) from 2.0 to 2.1.
- [Changelog](https://github.com/seddonym/import-linter/blob/master/CHANGELOG.rst)
- [Commits](seddonym/import-linter@v2.0...v2.1)

---
updated-dependencies:
- dependency-name: import-linter
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Performance test for `OmegaConfigLoader` (#4225)

* first pass doesn't work yet

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update ocl tests

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* revert some changes

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update to use larger config

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update functions and docstrings

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* lint

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

---------

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Add a test for init and fix indent

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Revert "Add a test for init and fix indent"

This reverts commit 0dbe3c7.

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Add a test for init and fix indent

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

---------

Signed-off-by: Greg Vaslowski <7269272+Vaslo@users.noreply.github.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
Signed-off-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>
Signed-off-by: Laura Couto <laurarccouto@gmail.com>
Signed-off-by: L. R. Couto <57910428+lrcouto@users.noreply.github.com>
Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com>
Signed-off-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com>
Signed-off-by: hyew0nChoi <statistic9935@naver.com>
Signed-off-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest Issue suitable for hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update CLI autocompletion docs
4 participants