Painless: Types Section Clean Up #30283

jdconrad · 2018-05-01T00:10:59Z

Cleaned up the types and casting sections of the painless spec including improved definitions, improved examples, and improved general structure.

examples are used.

elasticmachine · 2018-05-01T00:11:01Z

Pinging @elastic/es-core-infra

debadair

I added a few editorial comments. I don't see any structural issues.

debadair · 2018-05-16T18:37:36Z

docs/painless/painless-casting.asciidoc

-casts where you use the casting operator to explicitly convert one type to
-another. This is necessary during operations where the cast cannot be inferred.
+A cast is the conversion of the value of one type to the equivalent value of an
+inferred or specified type. Implicit casts are an inferred operation that


Instead of "is the conversion of", I'd go with "converts".

Either "Implicit casts are inferred operations that automatically convert" or "An implicit cast is an inferred operation that automatically converts". Same for explicit--pick singular or plural and stick with it.

debadair · 2018-05-16T18:43:50Z

docs/painless/painless-casting.asciidoc

+<<primitive-types, numeric types>> will result in data loss when the value of
+the type converted from is larger than the equivalent value of the type
+converted to can accommodate. Casts between values of integral types and values
+of floating point types will result in precision loss when the value of the


Maybe, "larger than the target type can accommodate"?

I'd drop the "wills" -- they do result in data/precision loss in those cases.

Maybe just "Casts between integer and floating point values can result in precision loss."?

debadair · 2018-05-16T18:50:03Z

docs/painless/painless-casting.asciidoc

-to floating point types.
+The table below illustrates allowed casts between values of
+<<primitive-types, numeric types>> and which specific casts must be explicit.
+Each cast is read as a conversion of row to column.



Maybe, "Each row shows the allowed casts for a particular type."?

debadair · 2018-05-16T18:51:40Z

docs/painless/painless-operators.asciidoc

-For more information about allocating and initializing arrays, see <<array-type,
-Array Type>>.
+To allocate an array, you use the `new` keyword followed by the type and a
+set of brackets for each dimension. You can explicitly define the size of each dimension by specifying an expression within the brackets, or initialize each


I'd drop the "you" and just use the imperative: "To allocate an array, use..."

This documentation was moved from another location to here, and I was hoping to address this as part of an operators clean up in the next PR if that's all right with you.

debadair · 2018-05-16T18:52:40Z

docs/painless/painless-operators.asciidoc


+To initialize an array, specify the values you want to initialize
+each dimension with as a comma-separated list of expressions enclosed in braces.
+For example, `new int[] {1, 2, 3}` creates a one-dimensional `int` array with a


I'd cut "specify the values you want to initialize each dimension with as".

Same as the comment above.

debadair · 2018-05-16T18:53:20Z

docs/painless/painless-operators.asciidoc

+size of 3 and the values 1, 2, and 3.
+
+When you initialize an array, the order of the expressions is maintained. Each expression used as part of the initialization is converted to the
+array's type. An error occurs if the types do not match.


I'd cut "used as part of the initialization".

Same as the comment above.

jdconrad · 2018-05-22T01:52:51Z

@debadair Thanks for the first round of review! Took another pass and did my best to clean up based on your comments. Ready for the next round.

debadair · 2018-05-23T20:12:35Z

LGTM!

jdconrad · 2018-05-23T20:36:35Z

@debadair Thank you for the review! I realize this is quite time consuming to look through.

* master: [DOCS] Splits auditing.asciidoc into smaller files Reintroduce mandatory http pipelining support (elastic#30820) Painless: Types Section Clean Up (elastic#30283) Add support for indexed shape routing in geo_shape query (elastic#30760) [test] java tests for archive packaging (elastic#30734) Revert "Make http pipelining support mandatory (elastic#30695)" (elastic#30813) [DOCS] Fix more edit URLs in Stack Overview (elastic#30704) Use correct cluster state version for node fault detection (elastic#30810) Change serialization version of doc-value fields. [DOCS] Fixes broken link for native realm [DOCS] Clarified audit.index.client.hosts (elastic#30797) [TEST] Don't expect acks when isolating nodes

* master: (25 commits) [DOCS] Splits auditing.asciidoc into smaller files Reintroduce mandatory http pipelining support (elastic#30820) Painless: Types Section Clean Up (elastic#30283) Add support for indexed shape routing in geo_shape query (elastic#30760) [test] java tests for archive packaging (elastic#30734) Revert "Make http pipelining support mandatory (elastic#30695)" (elastic#30813) [DOCS] Fix more edit URLs in Stack Overview (elastic#30704) Use correct cluster state version for node fault detection (elastic#30810) Change serialization version of doc-value fields. [DOCS] Fixes broken link for native realm [DOCS] Clarified audit.index.client.hosts (elastic#30797) [TEST] Don't expect acks when isolating nodes Add a `format` option to `docvalue_fields`. (elastic#29639) Fixes UpdateSettingsRequestStreamableTests mutate bug Mustes {p0=snapshot.get_repository/10_basic/*} YAML test Revert "Mutes MachineLearningTests.testNoAttributes_givenSameAndMlEnabled" Only allow x-pack metadata if all nodes are ready (elastic#30743) Mutes MachineLearningTests.testNoAttributes_givenSameAndMlEnabled Use original settings on full-cluster restart (elastic#30780) Only ack cluster state updates successfully applied on all nodes (elastic#30672) ...

Clean up of types section, casting section, and a large number of examples.

* 6.x: [DOCS] Fixes typos in security settings Add support for indexed shape routing in geo_shape query (#30760) [DOCS] Splits auditing.asciidoc into smaller files Painless: Types Section Clean Up (#30283) [test] java tests for archive packaging (#30734) Deprecate http.pipelining setting (#30786) [DOCS] Fix more edit URLs in Stack Overview (#30704) Use correct cluster state version for node fault detection (#30810) [DOCS] Fixes broken link for native realm [DOCS] Clarified audit.index.client.hosts (#30797) Change serialization version of doc-value fields. Add a `format` option to `docvalue_fields`. (#29639) [TEST] Don't expect acks when isolating nodes Fixes UpdateSettingsRequestStreamableTests mutate bug Revert "Add more yaml tests for get alias API (#29513)" Revert "Mutes MachineLearningTests.testNoAttributes_givenSameAndMlEnabled" Only allow x-pack metadata if all nodes are ready (#30743) Mutes MachineLearningTests.testNoAttributes_givenSameAndMlEnabled Use original settings on full-cluster restart (#30780) Only ack cluster state updates successfully applied on all nodes (#30672) Replace Request#setHeaders with addHeader (#30588) [TEST] remove endless wait in RestClientTests (#30776) QA: Add xpack tests to rolling upgrade (#30795) Add support for search templates to the high-level REST client. (#30473) Reduce CLI scripts to one-liners on Windows (#30772) Fold RestGetAllSettingsAction in RestGetSettingsAction (#30561) Add more yaml tests for get alias API (#29513) [Docs] Fix script-fields snippet execution (#30693) Convert FieldCapabilitiesResponse to a ToXContentObject. (#30182) Remove assert statements from field caps documentation. (#30601) Fix a bug in FieldCapabilitiesRequest#equals and hashCode. (#30181) Add support for field capabilities to the high-level REST client. (#29664) [DOCS] Add SAML configuration information (#30548) [DOCS] Remove X-Pack references from SQL CLI (#30694) [Docs] Fix typo in circuit breaker docs (#29659) [Feature] Adding a char_group tokenizer (#24186) Increase the maximum number of filters that may be in the cache. (#30655) [Docs] Fix broken cross link in documentation Test: wait for netty threads in a JUnit ClassRule (#30763) [Security] Include an empty json object in an json array when FLS filters out all fields (#30709) [DOCS] fixed incorrect default [TEST] Wait for CS to be fully applied in testDeleteCreateInOneBulk Enable installing plugins from snapshots.elastic.co (#30765) Ignore empty completion input (#30713) Fix docs failure on language analyzers (#30722) [Docs] Fix inconsistencies in snapshot/restore doc (#30480) Add Delete Repository High Level REST API (#30666) Reduce CLI scripts to one-liners (#30759)

* master: [DOCS] Fixes typos in security settings Fix GeoShapeQueryBuilder serialization after backport [DOCS] Splits auditing.asciidoc into smaller files Reintroduce mandatory http pipelining support (#30820) Painless: Types Section Clean Up (#30283) Add support for indexed shape routing in geo_shape query (#30760) [test] java tests for archive packaging (#30734) Revert "Make http pipelining support mandatory (#30695)" (#30813) [DOCS] Fix more edit URLs in Stack Overview (#30704) Use correct cluster state version for node fault detection (#30810) Change serialization version of doc-value fields. [DOCS] Fixes broken link for native realm [DOCS] Clarified audit.index.client.hosts (#30797) [TEST] Don't expect acks when isolating nodes Add a `format` option to `docvalue_fields`. (#29639) Fixes UpdateSettingsRequestStreamableTests mutate bug Mustes {p0=snapshot.get_repository/10_basic/*} YAML test Revert "Mutes MachineLearningTests.testNoAttributes_givenSameAndMlEnabled" Only allow x-pack metadata if all nodes are ready (#30743) Mutes MachineLearningTests.testNoAttributes_givenSameAndMlEnabled Use original settings on full-cluster restart (#30780) Only ack cluster state updates successfully applied on all nodes (#30672) Expose Lucene's FeatureField. (#30618) Fix a grammatical error in the 'search types' documentation. Remove http pipelining from integration test case (#30788)

* es/ccr: (55 commits) [DOCS] Fixes typos in security settings Fix GeoShapeQueryBuilder serialization after backport [DOCS] Splits auditing.asciidoc into smaller files Reintroduce mandatory http pipelining support (elastic#30820) Painless: Types Section Clean Up (elastic#30283) Add support for indexed shape routing in geo_shape query (elastic#30760) [test] java tests for archive packaging (elastic#30734) Revert "Make http pipelining support mandatory (elastic#30695)" (elastic#30813) [DOCS] Fix more edit URLs in Stack Overview (elastic#30704) Use correct cluster state version for node fault detection (elastic#30810) Change serialization version of doc-value fields. [DOCS] Fixes broken link for native realm [DOCS] Clarified audit.index.client.hosts (elastic#30797) [TEST] Don't expect acks when isolating nodes Mute CorruptedFileIT in CCR Add a `format` option to `docvalue_fields`. (elastic#29639) Fixes UpdateSettingsRequestStreamableTests mutate bug Mustes {p0=snapshot.get_repository/10_basic/*} YAML test Revert "Mutes MachineLearningTests.testNoAttributes_givenSameAndMlEnabled" Only allow x-pack metadata if all nodes are ready (elastic#30743) ...

jdconrad added 15 commits April 17, 2018 16:45

Separate identifiers into its own section. Clean up variables.

153d376

More docs.

6729d5f

Merge branch 'master' into docs1

84048e4

Merge branch 'master' into docs1

10fca6c

Modify language used to describe shallow copies.

c2c3448

Move examples into lists to make sections flow better when multiple

1cdf013

examples are used.

Update primitive types.

862962b

Cleaned up reference types.

73883ac

Clean up dynamic types.

7dfb034

String and void type clean up.

75f1498

Merge branch 'master' into docs2

f75d50e

Merge branch 'master' into docs2

956a188

Fixes.

bce78ed

Merge branch 'master' into docs2

b034cff

Clean up types section.

e82a1e0

jdconrad added >docs General docs changes :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache v7.0.0 v6.4.0 labels May 1, 2018

jdconrad requested a review from debadair May 1, 2018 00:11

jdconrad mentioned this pull request May 1, 2018

Painless: Improve Documentation #23777

Closed

22 tasks

jdconrad added 8 commits May 1, 2018 10:39

Merge branch 'master' into docs2

1da1704

Merge branch 'master' into docs3

48b3aee

Some casting and example clean up.

8bc0c74

Merge branch 'master' into docs3

275c2e7

Updated examples.

00ba531

More changes.

7bcd114

Merge branch 'master' into docs3

84ea43d

Merge branch 'master' into docs3

1cf2f0b

jdconrad added 5 commits May 14, 2018 13:28

Merge branch 'master' into docs3

bc4509f

More example clean up.

507ac48

More changes.

7ad4ebb

Finished promotion and boxing/unboxing.

a9c941e

Merge branch 'master' into docs2

0007d26

debadair reviewed May 16, 2018

View reviewed changes

jdconrad added 6 commits May 18, 2018 17:27

Cleaned up casting basic on PR comments.

988fc23

More changes.

b95ce25

Merge branch 'master' into docs2

a8ed00b

More fixes.

7b73010

Fixed casting and types based on PR feedback.

8fc4566

Cleaned up more.

ca2bb83

jdconrad added 2 commits May 22, 2018 11:03

Extra blank lines at end of docs.

ae1ae75

Merge branch 'master' into docs2

a5cc47a

jdconrad merged commit a96a45c into elastic:master May 23, 2018

jdconrad added the backport pending label May 23, 2018

jdconrad removed the backport pending label May 23, 2018

jdconrad added a commit that referenced this pull request May 23, 2018

Painless: Types Section Clean Up (#30283)

b905ef1

Clean up of types section, casting section, and a large number of examples.

jdconrad deleted the docs2 branch June 8, 2018 00:38

jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Painless: Types Section Clean Up #30283

Painless: Types Section Clean Up #30283

jdconrad commented May 1, 2018 •

edited

Loading

elasticmachine commented May 1, 2018

debadair left a comment

debadair May 16, 2018

jdconrad May 18, 2018

debadair May 16, 2018

jdconrad May 18, 2018

debadair May 16, 2018

jdconrad May 18, 2018

debadair May 16, 2018

jdconrad May 18, 2018

debadair May 16, 2018

jdconrad May 18, 2018

debadair May 16, 2018

jdconrad May 18, 2018

jdconrad commented May 22, 2018

debadair commented May 23, 2018

jdconrad commented May 23, 2018

Painless: Types Section Clean Up #30283

Painless: Types Section Clean Up #30283

Conversation

jdconrad commented May 1, 2018 • edited Loading

elasticmachine commented May 1, 2018

debadair left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jdconrad commented May 22, 2018

debadair commented May 23, 2018

jdconrad commented May 23, 2018

jdconrad commented May 1, 2018 •

edited

Loading