Rename 'json' to 'embedded_json'.#40712
Merged
jtibshirani merged 1 commit intoelastic:object-fieldsfrom Apr 2, 2019
Merged
Conversation
Collaborator
|
Pinging @elastic/es-search |
11 tasks
e11582e to
a5f6398
Compare
One concern around the name `json` is that because the entire document is JSON, new users may see this field and think that they should always use it. We thought that a more verbose name like `embedded_json` would help convey that the field type has a special, non-obvious purpose. This commit updates documentation references to `embedded_json`, but leaves the `JsonField` naming in the code to avoid very long class names.
a5f6398 to
a39650c
Compare
Contributor
Author
|
@elasticmachine run elasticsearch-ci/2 |
Contributor
Author
|
@elasticmachine run elasticsearch-ci/2 |
Contributor
Author
|
Thanks @jimczi for the review. |
jtibshirani
added a commit
that referenced
this pull request
Apr 10, 2019
One concern around the name `json` is that because the entire document is JSON, new users may see this field and think that they should always use it. We thought that a more verbose name like `embedded_json` would help convey that the field type has a special, non-obvious purpose. This commit updates documentation references to `embedded_json`, but leaves the `JsonField` naming in the code to avoid very long class names.
jtibshirani
added a commit
that referenced
this pull request
Apr 17, 2019
One concern around the name `json` is that because the entire document is JSON, new users may see this field and think that they should always use it. We thought that a more verbose name like `embedded_json` would help convey that the field type has a special, non-obvious purpose. This commit updates documentation references to `embedded_json`, but leaves the `JsonField` naming in the code to avoid very long class names.
jtibshirani
added a commit
that referenced
this pull request
May 1, 2019
One concern around the name `json` is that because the entire document is JSON, new users may see this field and think that they should always use it. We thought that a more verbose name like `embedded_json` would help convey that the field type has a special, non-obvious purpose. This commit updates documentation references to `embedded_json`, but leaves the `JsonField` naming in the code to avoid very long class names.
jtibshirani
added a commit
that referenced
this pull request
May 24, 2019
One concern around the name `json` is that because the entire document is JSON, new users may see this field and think that they should always use it. We thought that a more verbose name like `embedded_json` would help convey that the field type has a special, non-obvious purpose. This commit updates documentation references to `embedded_json`, but leaves the `JsonField` naming in the code to avoid very long class names.
jtibshirani
added a commit
that referenced
this pull request
May 29, 2019
One concern around the name `json` is that because the entire document is JSON, new users may see this field and think that they should always use it. We thought that a more verbose name like `embedded_json` would help convey that the field type has a special, non-obvious purpose. This commit updates documentation references to `embedded_json`, but leaves the `JsonField` naming in the code to avoid very long class names.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A concern around the name
jsonis that because the entire document is JSON,new users may see this field and think that they should always use it. We
thought that a more verbose name like
embedded_jsonwould help convey that thefield type has a special, non-obvious purpose.
This commit updates documentation references to
embedded_json, but leaves theJsonFieldnaming in the code to avoid very long class names.