Skip to content

Commit

Permalink
Applied suggested changes
Browse files Browse the repository at this point in the history
Signed-off-by: Elena Khaustova <[email protected]>
  • Loading branch information
ElenaKhaustova committed Oct 24, 2024
1 parent a5affbf commit a370536
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/source/data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,19 @@ how_to_create_a_custom_dataset
As of Kedro 0.19.9, you can explore a new experimental feature — the `KedroDataCatalog`, an enhanced alternative to `DataCatalog`.

At present, `KedroDataCatalog` replicates the functionality of `DataCatalog` and is fully compatible with the Kedro `run` command. It introduces several API improvements:
* Simplified dataset access: `_FrozenDatasets` has been replaced with public `get` method to retrieve datasets.
* Simplified dataset access: `_FrozenDatasets` has been replaced with a public `get` method to retrieve datasets.
* Added dict-like interface: You can now use a dictionary-like syntax to retrieve, set, and iterate over datasets.

For more details and examples of how to use `KedroDataCatalog`, see the Kedro Data Catalog page. The [documentation](./data_catalog.md) for `DataCatalog` remains relevant as `KedroDataCatalog` retains its core functionality with some enhancements.
For more details and examples of how to use `KedroDataCatalog`, see the Kedro Data Catalog page.

```{toctree}
:maxdepth: 1
kedro_data_catalog
```

The [documentation](./data_catalog.md) for `DataCatalog` remains relevant as `KedroDataCatalog` retains its core functionality with some enhancements.

```{note}
`KedroDataCatalog` is under active development and may undergo breaking changes in future releases. While we encourage you to try it out, please be aware of potential modifications as we continue to improve it. Additionally, all upcoming catalog-related features will be introduced through `KedroDataCatalog` before it replaces `DataCatalog`.
```
Expand Down
2 changes: 1 addition & 1 deletion docs/source/data/kedro_data_catalog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Kedro Data Catalog
`KedroDataCatalog` retains the core functionality of `DataCatalog`, with a few API enhancements. For a comprehensive understanding, we recommend reviewing the existing `DataCatalog` documentation before exploring the additional functionality of `KedroDataCatalog`.
`KedroDataCatalog` retains the core functionality of `DataCatalog`, with a few API enhancements. For a comprehensive understanding, we recommend reviewing the existing `DataCatalog` [documentation](./data_catalog.md) before exploring the additional functionality of `KedroDataCatalog`.

Check warning on line 2 in docs/source/data/kedro_data_catalog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/data/kedro_data_catalog.md#L2

[Kedro.weaselwords] 'few' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'few' is a weasel word!", "location": {"path": "docs/source/data/kedro_data_catalog.md", "range": {"start": {"line": 2, "column": 76}}}, "severity": "WARNING"}

This page highlights the new features and provides usage examples:
* [How to make KedroDataCatalog the default catalog for Kedro run](#how-to-make-kedrodatacatalog-the-default-catalog-for-kedro-run)

Check warning on line 5 in docs/source/data/kedro_data_catalog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/data/kedro_data_catalog.md#L5

[Kedro.ukspelling] In general, use UK English spelling instead of 'KedroDataCatalog'.
Raw output
{"message": "[Kedro.ukspelling] In general, use UK English spelling instead of 'KedroDataCatalog'.", "location": {"path": "docs/source/data/kedro_data_catalog.md", "range": {"start": {"line": 5, "column": 16}}}, "severity": "WARNING"}
Expand Down

0 comments on commit a370536

Please sign in to comment.