From 0d2c36c8f8529dd5f6f80a17e048a4c3a5ae5003 Mon Sep 17 00:00:00 2001 From: Mat Gadd Date: Tue, 30 Dec 2014 12:05:23 +0000 Subject: [PATCH] =?UTF-8?q?Typo=20fixes,=20mainly=20misuse=20of=20[it?= =?UTF-8?q?=E2=80=99s][oatmeal-1]/[its][oatmeal-2].?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [oatmeal-1]: http://s3.amazonaws.com/theoatmeal-img/comics/apostrophe/4.png [oatmeal-2]: http://s3.amazonaws.com/theoatmeal-img/comics/apostrophe/5.png --- docs/api_methods.asciidoc | 4 ++-- docs/api_methods_0_90.asciidoc | 4 ++-- docs/api_methods_1_0.asciidoc | 4 ++-- docs/api_methods_1_1.asciidoc | 4 ++-- docs/api_methods_1_2.asciidoc | 4 ++-- docs/api_methods_1_3.asciidoc | 4 ++-- docs/browser_builds.asciidoc | 2 +- docs/configuration.asciidoc | 2 +- docs/errors.asciidoc | 4 ++-- docs/extending_core_components.asciidoc | 2 +- docs/quick_start.asciidoc | 6 +++--- 11 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/api_methods.asciidoc b/docs/api_methods.asciidoc index 75ae1ecdc..26ac89d66 100644 --- a/docs/api_methods.asciidoc +++ b/docs/api_methods.asciidoc @@ -889,7 +889,7 @@ link:#[back to top] client.getSource([params, [callback]]) -------- -Get the source of a document by it's index, type and id. +Get the source of a document by its index, type and id. The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html[the elasticsearch docs] for more about this method. @@ -2953,7 +2953,7 @@ link:#[back to top] client.indices.close([params, [callback]]) -------- -Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations. +Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. The default method is `POST` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-open-close.html[the elasticsearch docs] for more about this method. diff --git a/docs/api_methods_0_90.asciidoc b/docs/api_methods_0_90.asciidoc index 9a4568303..fd97438d5 100644 --- a/docs/api_methods_0_90.asciidoc +++ b/docs/api_methods_0_90.asciidoc @@ -668,7 +668,7 @@ link:#[back to top] client.getSource([params, [callback]]) -------- -Get the source of a document by it's index, type and id. +Get the source of a document by its index, type and id. The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more about this method. @@ -1988,7 +1988,7 @@ link:#[back to top] client.indices.close([params, [callback]]) -------- -Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations. +Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. The default method is `POST` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more about this method. diff --git a/docs/api_methods_1_0.asciidoc b/docs/api_methods_1_0.asciidoc index dd689067b..00fdee9c9 100644 --- a/docs/api_methods_1_0.asciidoc +++ b/docs/api_methods_1_0.asciidoc @@ -763,7 +763,7 @@ link:#[back to top] client.getSource([params, [callback]]) -------- -Get the source of a document by it's index, type and id. +Get the source of a document by its index, type and id. The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html[the elasticsearch docs] for more about this method. @@ -2529,7 +2529,7 @@ link:#[back to top] client.indices.close([params, [callback]]) -------- -Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations. +Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. The default method is `POST` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method. diff --git a/docs/api_methods_1_1.asciidoc b/docs/api_methods_1_1.asciidoc index e4da88aa1..fdbda3f42 100644 --- a/docs/api_methods_1_1.asciidoc +++ b/docs/api_methods_1_1.asciidoc @@ -775,7 +775,7 @@ link:#[back to top] client.getSource([params, [callback]]) -------- -Get the source of a document by it's index, type and id. +Get the source of a document by its index, type and id. The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html[the elasticsearch docs] for more about this method. @@ -2607,7 +2607,7 @@ link:#[back to top] client.indices.close([params, [callback]]) -------- -Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations. +Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. The default method is `POST` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method. diff --git a/docs/api_methods_1_2.asciidoc b/docs/api_methods_1_2.asciidoc index cdd4b2f18..7c3d405c5 100644 --- a/docs/api_methods_1_2.asciidoc +++ b/docs/api_methods_1_2.asciidoc @@ -800,7 +800,7 @@ link:#[back to top] client.getSource([params, [callback]]) -------- -Get the source of a document by it's index, type and id. +Get the source of a document by its index, type and id. The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html[the elasticsearch docs] for more about this method. @@ -2720,7 +2720,7 @@ link:#[back to top] client.indices.close([params, [callback]]) -------- -Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations. +Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. The default method is `POST` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method. diff --git a/docs/api_methods_1_3.asciidoc b/docs/api_methods_1_3.asciidoc index cf4743be8..9c2f13b39 100644 --- a/docs/api_methods_1_3.asciidoc +++ b/docs/api_methods_1_3.asciidoc @@ -879,7 +879,7 @@ link:#[back to top] client.getSource([params, [callback]]) -------- -Get the source of a document by it's index, type and id. +Get the source of a document by its index, type and id. The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-get.html[the elasticsearch docs] for more about this method. @@ -2870,7 +2870,7 @@ link:#[back to top] client.indices.close([params, [callback]]) -------- -Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations. +Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. The default method is `POST` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-open-close.html[the elasticsearch docs] for more about this method. diff --git a/docs/browser_builds.asciidoc b/docs/browser_builds.asciidoc index c90a332f1..ac7b76934 100644 --- a/docs/browser_builds.asciidoc +++ b/docs/browser_builds.asciidoc @@ -3,7 +3,7 @@ We also provide builds of the elasticsearch.js client for use in the browser. These versions of the client are currently ***experimental***. We test these builds using https://saucelabs.com/u/elasticsearch-js[saucelabs] in Chrome, Firefox, and Internet Explorer 10, and 11. -While there is https://github.com/elasticsearch/elasticsearch-js/issues/96#issuecomment-42617480[a way to get it working in IE 9], the browser severly limits what you can do with cross-domain requests. Because of these limits, many of the API calls and other functionality do not work. +While there is https://github.com/elasticsearch/elasticsearch-js/issues/96#issuecomment-42617480[a way to get it working in IE 9], the browser severely limits what you can do with cross-domain requests. Because of these limits, many of the API calls and other functionality do not work. === Bower If you use bower to manage your dependencies, then just run: diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc index f55f54721..f62a99d8d 100644 --- a/docs/configuration.asciidoc +++ b/docs/configuration.asciidoc @@ -1,7 +1,7 @@ [[configuration]] == Configuration -The `Client` constructor accepts a single object as it's argument. In the <> section all of the available options/keys are listed. +The `Client` constructor accepts a single object as its argument. In the <> section all of the available options/keys are listed. [source,js] ------ diff --git a/docs/errors.asciidoc b/docs/errors.asciidoc index 3fe1cbb1a..7620b3cc0 100644 --- a/docs/errors.asciidoc +++ b/docs/errors.asciidoc @@ -7,7 +7,7 @@ These are the standard Error types which may be passed back from the client. To `ConnectionFault`:: The connection was unable to initiate or complete a request with the Elasticsearch node. `NoConnections`:: All of the connections in the ConnectionPool are dead. `RequestTimeout`:: The request timed-out. -`Serialization`:: The response received from Elasticsearch could not be deserilaized. +`Serialization`:: The response received from Elasticsearch could not be deserialized. `503` or `ServiceUnavailable`:: Elasticsearch responded with a 503 status. `500` or `InternalServerError`:: Elasticsearch responded with a 500 status. `412` or `PreconditionFailed`:: Elasticsearch responded with a 412 status. @@ -15,4 +15,4 @@ These are the standard Error types which may be passed back from the client. To `403` or `Forbidden`:: Elasticsearch responded with a 403 status. `404` or `NotFound`:: Elasticsearch responded with a 404 status. `400` or `BadRequest`:: Elasticsearch responded with a 400 status. -`Generic`:: Elasticsearch responded with a status that does not map to it's own error type. \ No newline at end of file +`Generic`:: Elasticsearch responded with a status that does not map to its own error type. diff --git a/docs/extending_core_components.asciidoc b/docs/extending_core_components.asciidoc index ab4439a0e..7fa3b51f3 100644 --- a/docs/extending_core_components.asciidoc +++ b/docs/extending_core_components.asciidoc @@ -29,4 +29,4 @@ var client = new elasticsearch.Client({ client.getDog( ... ); -------------- -When the client is created, it's prototype is set to the API version selected, and therefore you can access the client via the `this` variable within your API methods. Make requests within your methods using `this.transport.request(params, cb)`. For more information about the transport, see <>. \ No newline at end of file +When the client is created, its prototype is set to the API version selected, and therefore you can access the client via the `this` variable within your API methods. Make requests within your methods using `this.transport.request(params, cb)`. For more information about the transport, see <>. diff --git a/docs/quick_start.asciidoc b/docs/quick_start.asciidoc index 2332b7b4f..7960dc2d3 100644 --- a/docs/quick_start.asciidoc +++ b/docs/quick_start.asciidoc @@ -18,7 +18,7 @@ var client = new elasticsearch.Client({ Almost all of the methods on the client accept two arguments: * `params` - an optional object/hash of parameters <>. - * `callback` - an optional function that will be called with the final result of the method. When omitted, a https://github.com/cujojs/when/blob/master/docs/api.md#promise[promise] is returned. api-conventions-cb[More info here]. + * `callback` - an optional function that will be called with the final result of the method. When omitted, a https://github.com/cujojs/when/blob/master/docs/api.md#promise[promise] is returned. <>. ==== Ping the cluster @@ -70,11 +70,11 @@ client.indices.delete({ ----------------- === Searching for documents -A very common use-case for elasticsearch is to sort through large collections of documents in order to find ones that are relavent to a query. In most cases you will use the client's `search()` method to accomplish this. +A very common use-case for elasticsearch is to sort through large collections of documents in order to find ones that are relevant to a query. In most cases you will use the client's `search()` method to accomplish this. ==== Elasticsearch Query DSL -For many searches you will want to define a search document that tells elasticsearch exactly how to find the documents you are looking for. To do this you will use the http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html[elasticsearch query DSL]. If you are not familiary with Elasticsearch's query DSL is it recommended that you research the topic at elasticsearch.org or watch/read one of these introductions: +For many searches you will want to define a search document that tells elasticsearch exactly how to find the documents you are looking for. To do this you will use the http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html[elasticsearch query DSL]. If you are not familiar with Elasticsearch's query DSL is it recommended that you research the topic at elasticsearch.org or watch/read one of these introductions: * https://www.youtube.com/watch?v=52G5ZzE0XpY#t=1471[Clinton Gormley "Getting down and dirty with Elasticsearch"] * http://okfnlabs.org/blog/2013/07/01/elasticsearch-query-tutorial.html#query-dsl-overview[Querying Elasticsearch - A Tutorial and Guide]