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 about what the bootstrap_project and configure_project methods do and what they're supposed to be used for #1891

Closed
1 task
noklam opened this issue Oct 3, 2022 · 1 comment · Fixed by #3470
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@noklam
Copy link
Contributor

noklam commented Oct 3, 2022

Description

  • Add documentation about what the bootstrap_project and configure_project methods do and what they're supposed to be used for

Context

    We discussed this in **Technical Design** and talked about the following:
  • The package_name argument provided in KedroSession.create() doesn't do anything, which is confusing to users. This argument should be removed, but since that is a breaking change it will happen in 0.19
  • The workaround to run a run within a session is valid, but it's important to note that bootstrap_project is only meant for configuring a project that hasn't been packaged. When working with a packaged project configure_project should be used instead.
  • The problem with the main() method is that it currently returns an exit code, so downstream processes can't do anything with it.

Originally posted by @MerelTheisenQB in #1423 (comment)

@noklam
Copy link
Contributor Author

noklam commented Jan 3, 2024

Noted the package_name is obsoleted as it has been addressed by #1892

@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants