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

Clarify docs around custom resolvers #3524

Closed
astrojuanlu opened this issue Jan 17, 2024 · 1 comment · Fixed by #3759
Closed

Clarify docs around custom resolvers #3524

astrojuanlu opened this issue Jan 17, 2024 · 1 comment · Fixed by #3759
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Bug Report 🐞 Bug that needs to be fixed

Comments

@astrojuanlu
Copy link
Member

Description

https://docs.kedro.org/en/stable/configuration/advanced_configuration.html#how-to-use-custom-resolvers-with-omegaconfigloader two problems:

  1. for a newbie, it's not clear where the code should go (https://linen-slack.kedro.org/t/16316616/hello-this-is-my-grid-parameter-tuning-options-grid-batch-si#bc370de6-d106-45ef-9cb0-a3a79baa9e09)
  2. the code snippet mixes library code with REPL code, which makes it very confusing
@ElenaKhaustova
Copy link
Contributor

After looking through the described problems, the following was concluded:

  1. We have two sections in the docs touching custom resolvers: Advanced configuration without a full Kedro project and Advanced configuration without a full Kedro project
  2. Shared confusion about placing the code from here happened because we provided an example from Advanced configuration without a full Kedro project section which doesn't require placing code into any particular place as Kedro project is not needed.
  3. Advanced configuration without a full Kedro project describes well where to place the code with extensive examples.
  4. The code snippet mixes library code with REPL code in Advanced configuration without a full Kedro project indeed looks confusing.

From the above, the following changes were implemented:

Updated Advanced configuration without a full Kedro project docs section:

  • clarified that code can be run just as a Python script as a full Kedro project is not required;
  • split the code snippet from the output for clarity.

@astrojuanlu

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 Issue: Bug Report 🐞 Bug that needs to be fixed
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants