-
Notifications
You must be signed in to change notification settings - Fork 1k
Make sure all example code blocks for datasets are runnable #2287
Copy link
Copy link
Closed
Labels
Component: Example codeExample code creation/publicationExample code creation/publication
Description
Description
Some of the code examples we provide in the API docs for datasets (https://docs.kedro.org/en/stable/kedro_datasets.html#module-kedro_datasets) aren't actually runnable. Some datasets have easy and straightforward examples that can be copy-pasted and run straight away, others reference setup including S3, but it's not clear these snippets won't be runnable.
Implementation
Update all code snippets on in the dataset API docs to basic examples that can be run. And in case a simpler example doesn't make sense, clarify that this snippet can't be run as is and what additional setup would be needed.
Please also make sure the example refer to kedro-datasets but not kedro
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Component: Example codeExample code creation/publicationExample code creation/publication