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

Add documentation for how plugin CLI commands can be made lazy loaded #4027

Merged
merged 3 commits into from
Jul 24, 2024

Conversation

ankatiyar
Copy link
Contributor

Description

To go with the changes in #3883

Development notes

Added some documentation with an example of how plugin developers can make their CLI commands lazy loaded.

I extended the "simple plugin" example from the docs above but let me know if it doesn't make a 100% sense.

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

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

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

A small suggestion, but otherwise looks great! Thank you ⭐

docs/source/extend_kedro/plugins.md Outdated Show resolved Hide resolved
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.

Looks clear, nice addition! 🚀

docs/source/extend_kedro/plugins.md Outdated Show resolved Hide resolved
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
@ankatiyar ankatiyar enabled auto-merge (squash) July 24, 2024 10:27
@ankatiyar ankatiyar merged commit 5e15044 into main Jul 24, 2024
10 checks passed
@ankatiyar ankatiyar deleted the docs/lazy-subcommands-plugins branch July 24, 2024 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants