Skip to content
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

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

Open
ElenaKhaustova opened this issue Jun 5, 2024 · 1 comment
Open
Assignees
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@ElenaKhaustova
Copy link
Contributor

ElenaKhaustova commented Jun 5, 2024

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 #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.

>>> io = DataCatalog()

Screenshot 2024-06-05 at 18 15 46

@merelcht
Copy link
Member

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 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue: Feature Request New feature or improvement to existing feature
Projects
Status: In Review
Development

No branches or pull requests

4 participants