Skip to content
This repository has been archived by the owner on Jun 14, 2024. It is now read-only.

Deprecate IndexConfig in favor of type-specific configs #477

Open
clee704 opened this issue Jul 5, 2021 · 0 comments
Open

Deprecate IndexConfig in favor of type-specific configs #477

clee704 opened this issue Jul 5, 2021 · 0 comments
Assignees

Comments

@clee704
Copy link

clee704 commented Jul 5, 2021

Up to v0.4.0, users can create a single type of index using IndexConfig.

We are adding more index types. When there are multiple index types, IndexConfig can be confusing to users because it is actually just for a single type of index. Therefore, it would be better to change the class name of IndexConfig to CoveringIndexConfig to match the name of the index it creates, CoveringIndex.

Since it will break existing users' programs, to avoid unnecessary inconvenience to users, we can keep IndexConfig in v0.x and change the name from v1.0. Meanwhile, we can add deprecation warnings to IndexConfig - this is optional.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant