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

Provide better documentation on how the config glob pattern works #1462

Closed
idanov opened this issue Apr 21, 2022 · 1 comment · Fixed by #1971
Closed

Provide better documentation on how the config glob pattern works #1462

idanov opened this issue Apr 21, 2022 · 1 comment · Fixed by #1971
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@idanov
Copy link
Member

idanov commented Apr 21, 2022

Whilst issue #1363 raises more fundamental issues about the glob paths used by the configuration loader classes being tightly coupled with the low level context object, as an interim solution we should better document what actually happens because it's currently not very clear in the docs.

conf_catalog = self.config_loader.get("catalog*", "catalog*/**", "**/catalog*")

Looking for this information in the docs I checked the following places:

  1. configuration.md
    It is sort of present here, but not really comprehensive. We could also do a better job describing the thinking and relationship of AbstractConfigLoader

  2. kedro.config.ConfigLoader
    It's sort of in the docstring here, but not really comprehensive. We could make it very clear for readers.

We should also make sure we use word 'glob' in the header it's easily retrievable / search indexed / linkable

@noklam
Copy link
Contributor

noklam commented Apr 21, 2022

The ConfigLoader docstring maybe a good place for mentioning the default.

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.

5 participants