search

kedro-org / kedro

Kedro is a toolbox for production-ready data science. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular.
https://kedro.org
Apache License 2.0
9.47k stars 875 forks source link

[DataCatalog]: Revise methods and properties names for `DataCatalog` #3931

Open ElenaKhaustova opened 3 weeks ago

ElenaKhaustova commented 3 weeks ago

Description

Users find the naming of public functions, such as add_feed_dict, unclear and confusing, making it difficult to understand their purpose.

We propose to:

  1. Review and revise methods and properties names for DataCatalog to make them more descriptive and intuitive, clearly indicating their purpose and functionality.
  2. Revisit our usage examples to make them more informative for users and replace io with catalog.

Relates to https://github.com/kedro-org/kedro/issues/3612

Context

https://github.com/kedro-org/kedro/blob/27f5405cefd6701ffac4c6243030486fb7d3c942/kedro/io/data_catalog.py#L681

Screenshot 2024-06-05 at 18 15 46

merelcht commented 3 weeks ago

We could tackle this either by changing the current DataCatalog function names in the next breaking release, or by making sure that the public API for a new DataCatalog2 has better names. If we decide to build DataCatalog2 (obviously with a better name) alongside DataCatalog we don't actually need to do anything with this ticket, just keep in mind we name our methods clearly 🙂