Skip to content

Rename 'termsenum' API to 'terms_enum' for better readability#73119

Merged
sethmlarson merged 1 commit intomasterfrom
terms-enum-delimiter
May 17, 2021
Merged

Rename 'termsenum' API to 'terms_enum' for better readability#73119
sethmlarson merged 1 commit intomasterfrom
terms-enum-delimiter

Conversation

@sethmlarson
Copy link
Contributor

Follow up to #66452, raised a concern with @markharwood regarding readability for the new termsenum API when it would be implemented by language clients and suggested terms_enum. We agreed to rename the API resulting in this PR.

Is there anything we need to do to ensure the release notes will include the proper name for the API or are we covered?

@sethmlarson sethmlarson requested review from a team and markharwood May 14, 2021 18:31
@elasticsearchmachine elasticsearchmachine added the external-contributor Pull request authored by a developer outside the Elasticsearch team label May 14, 2021
@sethmlarson
Copy link
Contributor Author

I'm curious about the external-contributor label, the commit is signed with my @elastic.co email address.

Copy link
Contributor

@markharwood markharwood left a comment

Choose a reason for hiding this comment

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

Thanks for making this change. It aligns with the policy used on other two-word APIs like field_caps.

Is there anything we need to do to ensure the release notes will include the proper name for the API or are we covered?

I'm not too familiar with how release notes are generated to be honest. The original PR was labelled with "release_highlight` which I understand helps sets some wheels in motion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external-contributor Pull request authored by a developer outside the Elasticsearch team >non-issue v7.14.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants