kedro icon indicating copy to clipboard operation
kedro copied to clipboard

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

Open ElenaKhaustova opened this issue 8 months ago • 1 comments

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

  • Some user feedback: "I didn't even know what add_feed_dict did until someone explained it to me."
  • Currently, in some of our examples, we use io instead of catalog while the last is meant.

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

Screenshot 2024-06-05 at 18 15 46

ElenaKhaustova avatar Jun 05 '24 17:06 ElenaKhaustova