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

feat(js): rename empty to noResults #450

Merged
merged 2 commits into from
Feb 18, 2021
Merged

Conversation

francoischalifour
Copy link
Member

Why

The name empty was rather confusing and noResults reflects better when this template is displayed.

What

This renames all params that contain empty to noResults:

  • templates.emptytemplates.noResults
  • renderEmptyrenderNoResults
  • .aa-SourceEmpty.aa-SourceNoResults

Copy link
Contributor

@Haroenv Haroenv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is good! (don't forget to mark as a breaking change in the commit)


Function called to render an empty section when no hits are returned. It is useful for letting the user know that the query returned no results.
Function called to render a no results section when no hits are returned. It is useful for letting the user know that the query returned no results.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Function called to render a no results section when no hits are returned. It is useful for letting the user know that the query returned no results.
Function called to render a `no results` section when no hits are returned. It is useful for letting the user know that the query returned no results.

I feel like this should be "escaped" as it's more a naming than a term, not sure if you see what I mean

Copy link
Member Author

@francoischalifour francoischalifour Feb 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I agree—the docs team is gonna rewrite all the API refs so I'll wait for them to judge what's best 🙂

@francoischalifour francoischalifour merged commit 71ea2d0 into next Feb 18, 2021
@francoischalifour francoischalifour deleted the feat/empty-to-noresults branch February 18, 2021 11:02
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

Successfully merging this pull request may close these issues.

3 participants