Skip to content

[DOCS] Clarify copy for terms enum API's complete flag #76066

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Aug 5, 2021
Merged

[DOCS] Clarify copy for terms enum API's complete flag #76066

merged 4 commits into from
Aug 5, 2021

Conversation

@amitmbm
Copy link
Contributor

@amitmbm amitmbm commented Aug 4, 2021 •
edited
Loading

Fixing the #76065 (Docs bug on new terms enum API)

@elasticsearchmachine elasticsearchmachine added v8.0.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Aug 4, 2021
@amitmbm amitmbm mentioned this pull request Aug 4, 2021
Closed
@amitmbm
Copy link
Contributor Author

amitmbm commented Aug 4, 2021

@elasticsearchmachine

@jrodewig jrodewig linked an issue Aug 4, 2021 that may be closed by this pull request
[DOCS] Terms enum API's complete flag copy is unclear #76065
Closed
@jrodewig jrodewig changed the title Issue-76055 fixed documentation issue of terms enum API [DOCS] Clarify copy for terms enum API's complete flag Aug 4, 2021
jrodewig
jrodewig reviewed Aug 4, 2021
View reviewed changes
@jrodewig jrodewig requested a review from markharwood August 4, 2021 14:51
@jrodewig jrodewig added :Search/Search Search-related issues that do not fall into other categories >docs General docs changes v7.14.1 v7.15.0 labels Aug 4, 2021
@elasticmachine elasticmachine added Team:Search Meta label for search team Team:Docs Meta label for docs team labels Aug 4, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 4, 2021

Pinging @elastic/es-search (Team:Search)

@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 4, 2021

Pinging @elastic/es-docs (Team:Docs)

@jrodewig
Copy link
Contributor

jrodewig commented Aug 4, 2021

@elastimachine ok to test

@amitmbm
Copy link
Contributor Author

amitmbm commented Aug 4, 2021

Thanks @jrodewig for reviewing the changes, and for your suggestion.
I've added the suggestion, please approve the PR, so that it can be merged.

@jrodewig
Copy link
Contributor

jrodewig commented Aug 4, 2021

Thanks @amitmbm. I'd still like to wait for @markharwood's approval before merging.

@amitmbm
Copy link
Contributor Author

amitmbm commented Aug 4, 2021

Thanks @amitmbm. I'd still like to wait for @markharwood's approval before merging.

Sure, I am pinging him to that it can be merged soon, it's a new feature released in 7.14, and like me a lot of folks would be reading the docs 😄
@markharwood Could you please take a look at the latest changes?

@mark-vieira mark-vieira added auto-backport Automatically create backport pull requests when merged and removed auto-backport-and-merge labels Aug 4, 2021
markharwood
markharwood approved these changes Aug 5, 2021
View reviewed changes
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.

The sizing constraints were a potential future cause if we choose to add support for sorting by popularity. I'd drop that phrase for now and leave the other two as examples e.g.

This can occur due to a few reasons such as a request timeout or a node error.

Otherwise LGTM

@amitmbm
Copy link
Contributor Author

amitmbm commented Aug 5, 2021 •
edited
Loading

The sizing constraints were a potential future cause if we choose to add support for sorting by popularity. I'd drop that phrase for now and leave the other two as examples e.g.

This can occur due to a few reasons such as a request timeout or a node error.

Otherwise LGTM

Thanks @markharwood , Added your suggested changes, Could you please merge the changes.
cc @jrodewig

jrodewig
jrodewig reviewed Aug 5, 2021
View reviewed changes
jrodewig
jrodewig approved these changes Aug 5, 2021
View reviewed changes
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM. I'll merge and backport this once the CI tests pass.

@jrodewig jrodewig merged commit 7e7b5c9 into elastic:master Aug 5, 2021
elasticsearchmachine pushed a commit to elasticsearchmachine/elasticsearch that referenced this pull request Aug 5, 2021
@amitmbm @jrodewig
[DOCS] Clarify copy for terms enum API's complete flag (elastic#76066)
4a1b44f 
Co-authored-by: James Rodewig <[email protected]>
@elasticsearchmachine elasticsearchmachine mentioned this pull request Aug 5, 2021
Merged
elasticsearchmachine pushed a commit to elasticsearchmachine/elasticsearch that referenced this pull request Aug 5, 2021
@amitmbm @jrodewig
[DOCS] Clarify copy for terms enum API's complete flag (elastic#76066)
c5878fa 
Co-authored-by: James Rodewig <[email protected]>
@elasticsearchmachine elasticsearchmachine mentioned this pull request Aug 5, 2021
Merged
@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Aug 5, 2021

💚 Backport successful

Status Branch Result
✅ 7.14
✅ 7.x

elasticsearchmachine added a commit that referenced this pull request Aug 5, 2021
@elasticsearchmachine @amitmbm @jrodewig
[DOCS] Clarify copy for terms enum API's complete flag (#76066) (#7…
54f28ee 
…6170)

Co-authored-by: James Rodewig <[email protected]>

Co-authored-by: Elasticsearch addict <[email protected]>
Co-authored-by: James Rodewig <[email protected]>
elasticsearchmachine added a commit that referenced this pull request Aug 5, 2021
@elasticsearchmachine @amitmbm @jrodewig
[DOCS] Clarify copy for terms enum API's complete flag (#76066) (#7…
4e76ae3 
…6171)

Co-authored-by: James Rodewig <[email protected]>

Co-authored-by: Elasticsearch addict <[email protected]>
Co-authored-by: James Rodewig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@markharwood markharwood markharwood approved these changes

@jrodewig jrodewig jrodewig approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

auto-backport Automatically create backport pull requests when merged >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team Team:Search Meta label for search team v7.14.1 v7.15.0 v8.0.0-alpha2

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[DOCS] Terms enum API's complete flag copy is unclear

7 participants

@amitmbm @elasticmachine @jrodewig @elasticsearchmachine @markharwood @jakelandis @mark-vieira