Skip to content

Commit 1cdeb6f

Browse files
author
Paige Cook
committed
Fixes to typos, formatting, verbage, naming conventions, etc.
1 parent e18ac49 commit 1cdeb6f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+123
-124
lines changed

new_docs/contents/elasticsearch-net/building-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menuitem: esnet-building-requests
77

88
# Building Requests
99

10-
This section decribes how to build requests to elasticsearch.
10+
This section decribes how to build requests to Elasticsearch.
1111

1212
## Calling an API endpoint
1313

new_docs/contents/elasticsearch-net/cluster-failover.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menuitem: esnet-cluster-failover
77

88
# Connection pooling & Cluster failover
99

10-
One of the major benefits of `elasticsearch` is that it can handle dying and respawning nodes.
10+
One of the major benefits of `Elasticsearch` is that it can handle dying and respawning nodes.
1111
As long as enough nodes agree that the cluster is healthy, the cluster will continue to operate.
1212
`Elasticsearch.net` comes with builtin support to handle falling over to a different node when the requested node failed.
1313

@@ -38,7 +38,7 @@ Sets the timeout before a node is retried. The default `DateTimeProvider` will i
3838
Sets the maximum time a node may be marked dead.
3939

4040
#### DisablePings()
41-
By default before a previously dead node is retried a short ping will be send to the node to make sure the node will respond.
41+
By default before a previously dead node is retried a short ping will be sent to the node to make sure the node will respond.
4242
The reason for a separate call is that a ping will call an elasticsearch endpoint that won't stress the JVM. If a node is having issues retrying a possible heavy search operation on it might cause the request to fail later rather then asap. This setting allows you to disable these pings before retries.
4343

4444
#### SetMaxRetries(int retries)

new_docs/contents/elasticsearch-net/errors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menuitem: esnet-errors
77

88
# Errors
99

10-
`Elasticsearch.Net` will not throw if gets a http response other then 200 from Elasticsearch. The response object's `Success` property will be false and `.Error` will contain information on the failed response.
10+
`Elasticsearch.Net` will not throw if it gets an http response other then 200 from Elasticsearch. The response object's `Success` property will be false and `.Error` will contain information on the failed response.
1111

1212
You can throw custom exceptions if you need too by specifying a custom connectionhandler
1313

@@ -20,7 +20,7 @@ You can throw custom exceptions if you need too by specifying a custom connectio
2020

2121
## Exceptions
2222

23-
If a request has been retried the maximum amount of times a `MaxRetryException` is thrown. Note that requests are only retried when elasticsearch responds with a `503` or an unspecified connection exception (i.e timeout) occured on a node.
23+
If a request has been retried the maximum amount of times a `MaxRetryException` is thrown. Note that requests are only retried when elasticsearch responds with a `503` or an unspecified connection exception (i.e timeout) has occured on a node.
2424

2525
`MaxRetryException` will hold the original exception as `.InnerException`.
2626

new_docs/contents/elasticsearch-net/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menuitem: esnet-quick-start
77

88
# Quick Start
99

10-
`Elasticsearch.Net` is a low level client to talk to elasticsearch.
10+
`Elasticsearch.Net` is a low level client to talk to Elasticsearch.
1111

1212
## Installing
1313

new_docs/contents/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menuitem: introduction
77

88
# Introduction
99

10-
You've reached the documentation page for `Elasticsearch.Net` and `NEST`. Two .net clients to talk with elasticsearch. So why two clients I hear you say?
10+
You've reached the documentation page for `Elasticsearch.Net` and `NEST`. Two .net clients to talk with Elasticsearch. So why two clients I hear you say?
1111

1212
`Elasticsearch.Net` is a very low level, dependency free, client that has no opinions how you build and represent your requests and responses. It has abstracted
1313
enough so that **all** the elasticsearch API endpoints are represented as methods but not too much to get in the way of how you want to build your json/request/response objects. It also comes with builtin, configurable/overridable, cluster failover retry mechanisms. Elasticsearch is elastic so why not your client?
@@ -20,9 +20,9 @@ Please read the getting started guide for both.
2020
## Who's using Nest
2121
* [stackoverflow.com](http://www.stackoverflow.com) (and the rest of the stackexchange family).
2222
* [7digital.com](http://www.7digital.com) (run NEST on mono).
23-
* [rijksmuseum.nl](https://www.rijksmuseum.nl/en) (elasticsearch is the only datastorage hit for each page).
23+
* [rijksmuseum.nl](https://www.rijksmuseum.nl/en) (Elasticsearch is the only datastorage hit for each page).
2424
* [Kiln](http://www.fogcreek.com/kiln/) FogCreek's version control & code review tooling.
25-
They are so pleased with elasticsearch that [they made a video about how pleased they are!](http://blog.fogcreek.com/kiln-powered-by-elasticsearch/)
25+
They are so pleased with Elasticsearch that [they made a video about how pleased they are!](http://blog.fogcreek.com/kiln-powered-by-elasticsearch/)
2626

2727

2828
## Other resources

new_docs/contents/nest/cluster/health.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Get cluster health simple
1111

1212
var r = this._client.Health(HealthLevel.Cluster);
1313

14-
Cluster health just for one (or more) index
14+
Cluster health for one (or more) indexes
1515

1616
var r = this._client.Health(new[] { Test.Default.DefaultIndex }, HealthLevel.Cluster);
1717

new_docs/contents/nest/cluster/nodes-stats.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var r = this._client.NodeInfo(NodesInfo.All);
1212

1313
var node = r.Nodes.First();
1414

15-
you can than traverse the node info objects i.e:
15+
You can than traverse the node info objects i.e:
1616

1717
node.Value.OS.Cpu.CacheSizeInBytes;
1818

new_docs/contents/nest/connecting.markdown

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ If you want a failover client instead of passing a `Uri` pass an `IConnectionPoo
3030

3131
## Changing the underlying connection
3232

33-
By default NEST will use HTTP to chat with elasticsearch, alternative implementation of the transport layer can be injected in the constructors optional second parameter
33+
By default NEST will use HTTP to chat with elasticsearch, alternative implementation of the transport layer can be injected using the constructors optional second parameter
3434

3535
var client = new ElasticClient(settings, new ThriftConnection(settings));
3636

37-
Nest comes with a Htpp connection `HttpConnection`, Thrift Connection `ThriftConnection`
38-
and an in memory connection that nevers hits elasticsearch `InMemoryConnection`.
37+
NEST comes with an Http Connection `HttpConnection`, Thrift Connection `ThriftConnection`
38+
and an In-Memory Connection `InMemoryConnection`, that nevers hits elasticsearch.
3939

4040
## Settings
4141

@@ -50,8 +50,8 @@ The easiest way to pass `IConnectionSettingsValues` is to instantiate `Connectio
5050
.PluralizeTypeNames();
5151

5252
####AddContractJsonConverters
53-
Add a custom JsonConverter to the build in json serialization by passing
54-
in a predicate for a type. This way they will be part of the cached Json.net contract for a type.
53+
Add a custom JsonConverter to the built in JSON serialization by passing
54+
in a predicate for a type. This way they will be part of the cached Json.NET contract for a type.
5555

5656
settings.AddContractJsonConverters(t =>
5757
typeof (Enum).IsAssignableFrom(t)
@@ -74,15 +74,15 @@ Index to default to when no index is specified.
7474
####SetDefaultPropertyNameInferrer
7575
By default NEST camelCases property names (EmailAddress => emailAddress)
7676
that do not have an explicit propertyname either via an ElasticProperty attribute
77-
or because they are part of Dictionary where the keys should be treated verbatim.
77+
or because they are part of a Dictionary where the keys should be treated verbatim.
7878
Here you can register a function that transforms propertynames (default
7979
casing, pre- or suffixing)
8080

8181
####SetDefaultTypeNameInferrer
82-
Allows you to override how type names should be reprented, the default will
82+
Allows you to override how type names should be represented, the default will
8383
call .ToLowerInvariant() on the type's name.
8484

8585
####SetJsonSerializerSettingsModifier
86-
Allows you to update internal the json.net serializer settings to your liking.
87-
Do not use this to add custom json converters use `AddContractJsonConverters` instead.
86+
Allows you to update the internal Json.NET Serializer settings to your liking.
87+
Do not use this to add custom JSON converters use `AddContractJsonConverters` instead.
8888

new_docs/contents/nest/core/bulk.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ menuitem: bulk
88

99
# Bulk
1010

11-
Nest long supported bulk index and deletes (through `IndexMany()` and `DeleteMany()`) but this shielded you from all that the elasticsearch `_bulk` api enpoint has to offer. Now you can use `Bulk()` to create any bulk request you'd like. E.g if you want to do index/create/delete's in a certain order.
11+
NEST long supported bulk index and deletes (through `IndexMany()` and `DeleteMany()`) but this shielded you from all that the Elasticsearch `_bulk` api enpoint has to offer. Now you can use `Bulk()` to create any bulk request you'd like. E.g if you want to do index/create/delete's in a certain order.
1212

1313
# Examples
1414

@@ -18,7 +18,7 @@ Nest long supported bulk index and deletes (through `IndexMany()` and `DeleteMan
1818
.Delete<ElasticSearchProject>(i => i.Object(new ElasticSearchProject { Id = 4 }))
1919
);
2020

21-
Each bulk operation can also be anotated with the right behaviours:
21+
Each bulk operation can also be annotated with the right behaviours:
2222

2323
.Index<ElasticSearchProject>(i => i
2424
.Routing(...)

new_docs/contents/nest/core/count.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The count API allows to easily execute a query and get the number of matches for
1313
var countResults = this._client.CountAll(q=>q.MatchAll());
1414
Assert.True(countResults.Count > 0);
1515

16-
The above will do a count query across all indices. (The result type here is not)
16+
The above will do a count query across all indices. (The result type here is not limited)
1717

1818
If you want to limit the scope to just the default index for the type:
1919

0 commit comments

Comments
 (0)