-
Notifications
You must be signed in to change notification settings - Fork 909
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
Replace misspelt TemplateConfigLoader
references
#2450
Conversation
Signed-off-by: Deepyaman Datta <[email protected]>
Rebuilding, because kedro-datasets was uploaded to PyPI 14 minutes ago |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this @deepyaman !
@merelcht and I have been revising the configuration docs, including this page, so if we merge this fix in first, we will be able to pull it into our changes. Nice spot! 👀
@@ -255,7 +255,7 @@ Under the hood, `TemplatedConfigLoader` uses [`JMESPath` syntax](https://github. | |||
|
|||
### Jinja2 support | |||
|
|||
From version 0.17.0, `TemplateConfigLoader` also supports the [Jinja2](https://palletsprojects.com/p/jinja/) template engine alongside the original template syntax. Below is an example of a `catalog.yml` file that uses both features: | |||
From version 0.17.0, `TemplatedConfigLoader` also supports the [Jinja2](https://palletsprojects.com/p/jinja/) template engine alongside the original template syntax. Below is an example of a `catalog.yml` file that uses both features: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sharing this because we're not using this feature more widely in our docs:
From version 0.17.0, `TemplatedConfigLoader` also supports the [Jinja2](https://palletsprojects.com/p/jinja/) template engine alongside the original template syntax. Below is an example of a `catalog.yml` file that uses both features: | |
From version 0.17.0, {class}`~kedro.config.TemplatedConfigLoader` also supports the [Jinja2](https://palletsprojects.com/p/jinja/) template engine alongside the original template syntax. Below is an example of a `catalog.yml` file that uses both features: |
This is clearly longer and more cumbersome to type, but generates a cross-reference to the TemplatedConfigLoader
documentation, and emits a warning in case of a typo.
(I haven't tested this locally because emmmm I'm having some problems building the docs locally, working on it)
(In docstrings this is not needed, because these references are expanded automatically as long as they're wrapped in backquotes)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are all the objects in the intersphinx objects inventory that can be referenced from inside or outside the docs https://webknjaz.github.io/intersphinx-untangled/docs.kedro.org/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@astrojuanlu Sorry, I saw this comment but didn't get a chance to test it either. But I trust your knowledge of doc building/am on board, if want to do this still in another PR. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current state of our docs is... bad, so let's revisit this after I close #2454
Signed-off-by: Deepyaman Datta <[email protected]> Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>
Description
Development notes
Checklist
RELEASE.md
file