Skip to content

Commit

Permalink
[DOCS] Fix double spaces (elastic#71082)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Mar 31, 2021
1 parent 83725e4 commit 693807a
Show file tree
Hide file tree
Showing 282 changed files with 834 additions and 834 deletions.
8 changes: 4 additions & 4 deletions TESTING.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ password: `elastic-password`.

=== Test case filtering.

You can run a single test, provided that you specify the Gradle project. See the documentation on
You can run a single test, provided that you specify the Gradle project. See the documentation on
https://docs.gradle.org/current/userguide/userguide_single.html#simple_name_pattern[simple name pattern filtering].

Run a single test case in the `server` project:
Expand Down Expand Up @@ -385,13 +385,13 @@ vagrant plugin install vagrant-cachier
. You can run all of the OS packaging tests with `./gradlew packagingTest`.
This task includes our legacy `bats` tests. To run only the OS tests that are
written in Java, run `.gradlew distroTest`, will cause Gradle to build the tar,
zip, and deb packages and all the plugins. It will then run the tests on every
zip, and deb packages and all the plugins. It will then run the tests on every
available system. This will take a very long time.
+
Fortunately, the various systems under test have their own Gradle tasks under
`qa/os`. To find the systems tested, do a listing of the `qa/os` directory.
To find out what packaging combinations can be tested on a system, run
the `tasks` task. For example:
the `tasks` task. For example:
+
----------------------------------
./gradlew :qa:os:ubuntu-1804:tasks
Expand Down Expand Up @@ -558,7 +558,7 @@ fetching the latest from the remote.

== Testing in FIPS 140-2 mode

We have a CI matrix job that periodically runs all our tests with the JVM configured
We have a CI matrix job that periodically runs all our tests with the JVM configured
to be FIPS 140-2 compliant with the use of the BouncyCastle FIPS approved Security Provider.
FIPS 140-2 imposes certain requirements that affect how our tests should be set up or what
can be tested. This section summarizes what one needs to take into consideration so that
Expand Down
2 changes: 1 addition & 1 deletion docs/community-clients/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Also see the {client}/php-api/current/index.html[official Elasticsearch PHP clie

* https://github.com/nervetattoo/elasticsearch[elasticsearch] PHP client.

* https://github.com/madewithlove/elasticsearcher[elasticsearcher] Agnostic lightweight package on top of the Elasticsearch PHP client. Its main goal is to allow for easier structuring of queries and indices in your application. It does not want to hide or replace functionality of the Elasticsearch PHP client.
* https://github.com/madewithlove/elasticsearcher[elasticsearcher] Agnostic lightweight package on top of the Elasticsearch PHP client. Its main goal is to allow for easier structuring of queries and indices in your application. It does not want to hide or replace functionality of the Elasticsearch PHP client.

[[python]]
== Python
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/document/term-vectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ offsets.
payloads.
<6> Set `filterSettings` to filter the terms that can be returned based
on their tf-idf scores.
<7> Set `perFieldAnalyzer` to specify a different analyzer than
<7> Set `perFieldAnalyzer` to specify a different analyzer than
the one that the field has.
<8> Set `realtime` to `false` (default is `true`) to retrieve term vectors
near realtime.
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/indices/analyze.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The simplest version uses a built-in analyzer:
include-tagged::{doc-tests-file}[{api}-builtin-request]
---------------------------------------------------
<1> A built-in analyzer
<2> The text to include. Multiple strings are treated as a multi-valued field
<2> The text to include. Multiple strings are treated as a multi-valued field

You can configure a custom analyzer:
["source","java",subs="attributes,callouts,macros"]
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/indices/freeze_index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request-waitForActiveShards]
--------------------------------------------------
<1> The number of active shard copies to wait for before the freeze index API
<1> The number of active shard copies to wait for before the freeze index API
returns a response, as an `ActiveShardCount`

["source","java",subs="attributes,callouts,macros"]
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/indices/get_settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following arguments can optionally be provided:
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request-names]
--------------------------------------------------
<1> One or more settings that be the only settings retrieved. If unset, all settings will be retrieved
<1> One or more settings that be the only settings retrieved. If unset, all settings will be retrieved

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/indices/open_index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ include-tagged::{doc-tests-file}[{api}-request-waitForActiveShards]
--------------------------------------------------
<1> The number of active shard copies to wait for before the open index API
returns a response, as an `int`
<2> The number of active shard copies to wait for before the open index API
<2> The number of active shard copies to wait for before the open index API
returns a response, as an `ActiveShardCount`

["source","java",subs="attributes,callouts,macros"]
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/indices/unfreeze_index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request-waitForActiveShards]
--------------------------------------------------
<1> The number of active shard copies to wait for before the unfreeze index API
<1> The number of active shard copies to wait for before the unfreeze index API
returns a response, as an `ActiveShardCount`

["source","java",subs="attributes,callouts,macros"]
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/licensing/start-basic.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ license started. If it was not started, it returns an error message describing
why.

Acknowledgement messages may also be returned if this API was called without
the `acknowledge` flag set to `true`. In this case you need to display the
the `acknowledge` flag set to `true`. In this case you need to display the
messages to the end user and if they agree, resubmit the request with the
`acknowledge` flag set to `true`. Please note that the response will still
return a 200 return code even if it requires an acknowledgement. So, it is
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/licensing/start-trial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ license started. If it was not started, it returns an error message describing
why.

Acknowledgement messages may also be returned if this API was called without
the `acknowledge` flag set to `true`. In this case you need to display the
the `acknowledge` flag set to `true`. In this case you need to display the
messages to the end user and if they agree, resubmit the request with the
`acknowledge` flag set to `true`. Please note that the response will still
return a 200 return code even if it requires an acknowledgement. So, it is
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/rollup/get_rollup_caps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ include-tagged::{doc-tests-file}[x-pack-{api}-execute]

The returned +{response}+ holds lists and maps of values which correspond to the capabilities
of the target index/index pattern (what jobs were configured for the pattern, where the data is stored, what
aggregations are available, etc). It provides essentially the same data as the original job configuration,
aggregations are available, etc). It provides essentially the same data as the original job configuration,
just presented in a different manner.

For example, if we had created a job with the following config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
experimental::[]

The Get Rollup Index Capabilities API allows the user to determine if a concrete index or index pattern contains
stored rollup jobs and data. If it contains data stored from rollup jobs, the capabilities of those jobs
stored rollup jobs and data. If it contains data stored from rollup jobs, the capabilities of those jobs
are returned. The API accepts a `GetRollupIndexCapsRequest` object as a request and returns a `GetRollupIndexCapsResponse`.

[id="{upid}-x-pack-{api}-request"]
Expand Down Expand Up @@ -40,7 +40,7 @@ include-tagged::{doc-tests-file}[x-pack-{api}-execute]

The returned +{response}+ holds lists and maps of values which correspond to the capabilities
of the rollup index/index pattern (what jobs are stored in the index, their capabilities, what
aggregations are available, etc). Because multiple jobs can be stored in one index, the
aggregations are available, etc). Because multiple jobs can be stored in one index, the
response may include several jobs with different configurations.

The capabilities are essentially the same as the original job configuration, just presented in a different
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/security/has-privileges.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ if the privilege was not part of the request).
A `Map<String, Map<String, Map<String, Boolean>>>>` where each key is the
name of an application (as specified in the +{request}+).
For each application, the value is a `Map` keyed by resource name, with
each value being another `Map` from privilege name to a `Boolean`.
each value being another `Map` from privilege name to a `Boolean`.
The `Boolean` value is `true` if the user has that privilege on that
resource for that application, and `false` otherwise.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ include-tagged::{doc-tests}/SnapshotClientDocumentationIT.java[delete-snapshot-e
[[java-rest-high-snapshot-delete-snapshot-async]]
==== Asynchronous Execution

The asynchronous execution of a delete snapshot request requires both the
The asynchronous execution of a delete snapshot request requires both the
`DeleteSnapshotRequest` instance and an `ActionListener` instance to be
passed to the asynchronous method:

Expand Down
4 changes: 2 additions & 2 deletions docs/java-rest/low-level/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ should be consulted: https://hc.apache.org/httpcomponents-asyncclient-4.1.x/ .

NOTE: If your application runs under the security manager you might be subject
to the JVM default policies of caching positive hostname resolutions
indefinitely and negative hostname resolutions for ten seconds. If the resolved
indefinitely and negative hostname resolutions for ten seconds. If the resolved
addresses of the hosts to which you are connecting the client to vary with time
then you might want to modify the default JVM behavior. These can be modified by
adding
Expand Down Expand Up @@ -184,6 +184,6 @@ whenever none of the nodes from the preferred rack is available.

WARNING: Node selectors that do not consistently select the same set of nodes
will make round-robin behaviour unpredictable and possibly unfair. The
preference example above is fine as it reasons about availability of nodes
preference example above is fine as it reasons about availability of nodes
which already affects the predictability of round-robin. Node selection should
not depend on other external factors or round-robin will not work properly.
2 changes: 1 addition & 1 deletion docs/java-rest/low-level/sniffer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ include-tagged::{doc-tests}/SnifferDocumentation.java[sniff-on-failure]
failure, but an additional sniffing round is also scheduled sooner than usual,
by default one minute after the failure, assuming that things will go back to
normal and we want to detect that as soon as possible. Said interval can be
customized at `Sniffer` creation time through the `setSniffAfterFailureDelayMillis`
customized at `Sniffer` creation time through the `setSniffAfterFailureDelayMillis`
method. Note that this last configuration parameter has no effect in case sniffing
on failure is not enabled like explained above.
<3> Set the `Sniffer` instance to the failure listener
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The standard <<painless-api-reference-shared, Painless API>> is available.

To run this example, first follow the steps in <<painless-context-examples, context examples>>.

The painless context in a `bucket_script` aggregation provides a `params` map. This map contains both
The painless context in a `bucket_script` aggregation provides a `params` map. This map contains both
user-specified custom values, as well as the values from other aggregations specified in the `buckets_path`
property.

Expand All @@ -36,7 +36,7 @@ and adds the user-specified base_cost to the result:
(params.max - params.min) + params.base_cost
--------------------------------------------------

Note that the values are extracted from the `params` map. In context, the aggregation looks like this:
Note that the values are extracted from the `params` map. In context, the aggregation looks like this:

[source,console]
--------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The standard <<painless-api-reference-shared, Painless API>> is available.

To run this example, first follow the steps in <<painless-context-examples, context examples>>.

The painless context in a `bucket_selector` aggregation provides a `params` map. This map contains both
The painless context in a `bucket_selector` aggregation provides a `params` map. This map contains both
user-specified custom values, as well as the values from other aggregations specified in the `buckets_path`
property.

Expand All @@ -41,7 +41,7 @@ params.max + params.base_cost > 10
--------------------------------------------------

Note that the values are extracted from the `params` map. The script is in the form of an expression
that returns `true` or `false`. In context, the aggregation looks like this:
that returns `true` or `false`. In context, the aggregation looks like this:

[source,console]
--------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ full metric aggregation.
*Side Effects*

`state` (`Map`)::
Add values to this `Map` to for use in a map. Additional values must
Add values to this `Map` to for use in a map. Additional values must
be of the type `Map`, `List`, `String` or primitive.

*Return*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ part of a full metric aggregation.
primitive. The same `state` `Map` is shared between all aggregated documents
on a given shard. If an initialization script is provided as part of the
aggregation then values added from the initialization script are
available. If no combine script is specified, values must be
available. If no combine script is specified, values must be
directly stored in `state` in a usable form. If no combine script and no
<<painless-metric-agg-reduce-context, reduce script>> are specified, the
`state` values are used as the result.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ score to documents returned from a query.
User-defined parameters passed in as part of the query.

`doc` (`Map`, read-only)::
Contains the fields of the current document. For single-valued fields,
the value can be accessed via `doc['fieldname'].value`. For multi-valued
Contains the fields of the current document. For single-valued fields,
the value can be accessed via `doc['fieldname'].value`. For multi-valued
fields, this returns the first value; other values can be accessed
via `doc['fieldname'].get(index)`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ documents in a query.
The weight as calculated by a <<painless-weight-context,weight script>>

`query.boost` (`float`, read-only)::
The boost value if provided by the query. If this is not provided the
The boost value if provided by the query. If this is not provided the
value is `1.0f`.

`field.docCount` (`long`, read-only)::
The number of documents that have a value for the current field.

`field.sumDocFreq` (`long`, read-only)::
The sum of all terms that exist for the current field. If this is not
The sum of all terms that exist for the current field. If this is not
available the value is `-1`.

`field.sumTotalTermFreq` (`long`, read-only)::
The sum of occurrences in the index for all the terms that exist in the
current field. If this is not available the value is `-1`.
current field. If this is not available the value is `-1`.

`term.docFreq` (`long`, read-only)::
The number of documents that contain the current term in the index.
Expand All @@ -32,7 +32,7 @@ documents in a query.
The total occurrences of the current term in the index.

`doc.length` (`long`, read-only)::
The number of tokens the current document has in the current field. This
The number of tokens the current document has in the current field. This
is decoded from the stored {ref}/norms.html[norms] and may be approximate for
long fields

Expand All @@ -45,7 +45,7 @@ Note that the `query`, `field`, and `term` variables are also available to the
there, as they are constant for all documents.

For queries that contain multiple terms, the script is called once for each
term with that term's calculated weight, and the results are summed. Note that some
term with that term's calculated weight, and the results are summed. Note that some
terms might have a `doc.freq` value of `0` on a document, for example if a query
uses synonyms.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Use a Painless script to
User-defined parameters passed in as part of the query.

`doc` (`Map`, read-only)::
Contains the fields of the current document. For single-valued fields,
the value can be accessed via `doc['fieldname'].value`. For multi-valued
Contains the fields of the current document. For single-valued fields,
the value can be accessed via `doc['fieldname'].value`. For multi-valued
fields, this returns the first value; other values can be accessed
via `doc['fieldname'].get(index)`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Use a Painless script to create a
{ref}/index-modules-similarity.html[weight] for use in a
<<painless-similarity-context, similarity script>>. The weight makes up the
<<painless-similarity-context, similarity script>>. The weight makes up the
part of the similarity calculation that is independent of the document being
scored, and so can be built up front and cached.

Expand All @@ -12,19 +12,19 @@ Queries that contain multiple terms calculate a separate weight for each term.
*Variables*

`query.boost` (`float`, read-only)::
The boost value if provided by the query. If this is not provided the
The boost value if provided by the query. If this is not provided the
value is `1.0f`.

`field.docCount` (`long`, read-only)::
The number of documents that have a value for the current field.

`field.sumDocFreq` (`long`, read-only)::
The sum of all terms that exist for the current field. If this is not
The sum of all terms that exist for the current field. If this is not
available the value is `-1`.

`field.sumTotalTermFreq` (`long`, read-only)::
The sum of occurrences in the index for all the terms that exist in the
current field. If this is not available the value is `-1`.
current field. If this is not available the value is `-1`.

`term.docFreq` (`long`, read-only)::
The number of documents that contain the current term in the index.
Expand Down
2 changes: 1 addition & 1 deletion docs/painless/painless-lang-spec/painless-casting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
A cast converts the value of an original type to the equivalent value of a
target type. An implicit cast infers the target type and automatically occurs
during certain <<painless-operators, operations>>. An explicit cast specifies
the target type and forcefully occurs as its own operation. Use the `cast
the target type and forcefully occurs as its own operation. Use the `cast
operator '()'` to specify an explicit cast.

Refer to the <<allowed-casts, cast table>> for a quick reference on all
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ to repeat its specific task. A parameter is a named type value available as a
function specifies zero-to-many parameters, and when a function is called a
value is specified per parameter. An argument is a value passed into a function
at the point of call. A function specifies a return type value, though if the
type is <<void-type, void>> then no value is returned. Any non-void type return
type is <<void-type, void>> then no value is returned. Any non-void type return
value is available for use within an <<painless-operators, operation>> or is
discarded otherwise.

Expand Down
Loading

0 comments on commit 693807a

Please sign in to comment.