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

Rename indexSelector to sortBySelector #485

Closed
vvo opened this issue Nov 6, 2015 · 2 comments
Closed

Rename indexSelector to sortBySelector #485

vvo opened this issue Nov 6, 2015 · 2 comments
Assignees
Milestone

Comments

@vvo
Copy link
Contributor

vvo commented Nov 6, 2015

I want to rename this widget before 1.0.0 mostly because that's the only widget having a name that is based on the internal implementation of sorts in Algolia.

Basically we may find it really nice to be named "indexSelector" because we know that to order results we need multiple indexes.

But for a new user this will look weird at first glance I am sure.

I would prefer to name it sortBySelector and in the documentation clearly state that the requirement is to have multiple indices. This will be enough.

WDYT?

@vvo vvo added this to the 1.0.0 milestone Nov 6, 2015
@pixelastic
Copy link
Contributor

I'm ok with that. The fact that we need several indices for several sort order should appear in the "Algolia requirements" part of the doc.

@redox
Copy link
Contributor

redox commented Nov 12, 2015

Go for it.

@redox redox self-assigned this Nov 13, 2015
redox added a commit that referenced this issue Nov 13, 2015
Fix #485

BREAKING CHANGE: the `indexSelector` has been renamed to
`sortBySelector`.
@redox redox added in progress and removed ready labels Nov 13, 2015
redox added a commit that referenced this issue Nov 16, 2015
Fix #485

BREAKING CHANGE: the `indexSelector` has been renamed to
`sortBySelector`.
@redox redox closed this as completed in df9b9ce Nov 16, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants