Skip to content

Commit

Permalink
Fix spelling mistakes. (#4221)
Browse files Browse the repository at this point in the history
Fix spelling mistakes and regenerate docs

(cherry picked from commit 448c4d0)
  • Loading branch information
codebrain committed Nov 13, 2019
1 parent bdce824 commit fb24a3d
Show file tree
Hide file tree
Showing 18 changed files with 18 additions and 20 deletions.
Expand Up @@ -78,7 +78,7 @@ However we encourage you to pass connection settings explicitly.
==== CloudConnectionPool

A specialized subclass of `SingleNodeConnectionPool` that accepts a Cloud Id and credentials.
When used the client will also pick Elastic Cloud optmized defaults for the connection settings.
When used the client will also pick Elastic Cloud optimized defaults for the connection settings.

A Cloud Id for your cluster can be fetched from your Elastic Cloud cluster administration console.

Expand Down
Expand Up @@ -114,7 +114,6 @@ audit = await audit.TraceCall(
}
);
----
<1> diable ping and sniff

<1> disable ping and sniff
<2> no ping or sniff before the call

Expand Up @@ -47,7 +47,7 @@ var audit = new Auditor(() => VirtualClusterWith
);
----

healty cluster all nodes return healthy responses
healthy cluster all nodes return healthy responses

[source,csharp]
----
Expand Down
Expand Up @@ -275,7 +275,7 @@ var settings = new ConnectionConfiguration(uri);
----
but this can be awkward when using connection pooling with multiple nodes, especially when the connection pool
used is one that is capable of reseeding iteslf. For this reason, we'd recommend specifying credentials
used is one that is capable of reseeding itself. For this reason, we'd recommend specifying credentials
on `ConnectionSettings`.
====
Expand Down
Expand Up @@ -296,7 +296,7 @@ ndexResponse = client.Index(indexRequest);
ndexResponse.ApiCall.Uri.Query.Should().Contain("routing=1337");
----

Its important to note that the routing is resolved at request time, not instantation time
Its important to note that the routing is resolved at request time, not instantiation time
here we update the `child`'s `JoinField` after already creating the index request for `child`

[source,csharp]
Expand Down
Expand Up @@ -52,7 +52,7 @@ public class MyPluginProperty : IProperty
`PropertyNameAttribute` can be used to mark properties that should be serialized. Without this attribute,
NEST won't pick up the property for serialization.

Now that we have our own `IProperty` implementation we can add it to our propertes mapping when creating an index
Now that we have our own `IProperty` implementation we can add it to our properties mapping when creating an index

[source,csharp]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/client-concepts/low-level/lifetimes.asciidoc
Expand Up @@ -74,7 +74,7 @@ private class AConnection : InMemoryConnection
}
----

`ConnectionSettings`, `IConnectionPool` and `IConnection` all explictily implement `IDisposable`
`ConnectionSettings`, `IConnectionPool` and `IConnection` all explicitly implement `IDisposable`

[source,csharp]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/client-concepts/low-level/post-data.asciidoc
Expand Up @@ -62,7 +62,7 @@ fromByteArray.Type.Should().Be(PostType.ByteArray);
[float]
=== Other types of PostData

You can also pass the following objects directy to the low level client.
You can also pass the following objects directly to the low level client.

* A Serializable `object`

Expand Down
2 changes: 1 addition & 1 deletion docs/common-options/time-unit/time-units.asciidoc
Expand Up @@ -180,7 +180,7 @@ that accepts a factor and time unit, or specify a string with ms time units
==== Units of Time

Where Units of Time can be specified as a union of either a `DateInterval` or `Time`,
a `DateInterval` or `Time` may be passed which will be implicity converted to a
a `DateInterval` or `Time` may be passed which will be implicitly converted to a
`Union<DateInterval, Time>`, the serialized form of which represents the initial value
passed

Expand Down
Expand Up @@ -70,7 +70,7 @@ public void AvailableOptions()
}
/**
* but this can be awkward when using connection pooling with multiple nodes, especially when the connection pool
* used is one that is capable of reseeding iteslf. For this reason, we'd recommend specifying credentials
* used is one that is capable of reseeding itself. For this reason, we'd recommend specifying credentials
* on `ConnectionSettings`.
*====
*/
Expand Down
Expand Up @@ -90,7 +90,7 @@ public class ConnectionPooling
* ==== CloudConnectionPool
*
* A specialized subclass of `SingleNodeConnectionPool` that accepts a Cloud Id and credentials.
* When used the client will also pick Elastic Cloud optmized defaults for the connection settings.
* When used the client will also pick Elastic Cloud optimized defaults for the connection settings.
*
* A Cloud Id for your cluster can be fetched from your Elastic Cloud cluster administration console.
*
Expand Down
Expand Up @@ -90,7 +90,7 @@ public class DisableSniffPingPerRequest
);

audit = await audit.TraceCall(
new ClientCall(r=>r.DisableSniffing().DisablePing()) // <1> diable ping and sniff
new ClientCall(r=>r.DisableSniffing().DisablePing()) // <1> disable ping and sniff
{
{ HealthyResponse, 9200 } // <2> no ping or sniff before the call
}
Expand Down
Expand Up @@ -47,7 +47,7 @@ public async Task ASniffOnStartupHappens()
.SniffLifeSpan(TimeSpan.FromMinutes(30))
)
);
/** healty cluster all nodes return healthy responses*/
/** healthy cluster all nodes return healthy responses*/
audit = await audit.TraceCalls(
new ClientCall { { HealthyResponse, 9200 } },
new ClientCall { { HealthyResponse, 9201 } },
Expand Down
Expand Up @@ -296,7 +296,7 @@ public void Inference()
ndexResponse = client.Index(indexRequest);
ndexResponse.ApiCall.Uri.Query.Should().Contain("routing=1337");
/**
* Its important to note that the routing is resolved at request time, not instantation time
* Its important to note that the routing is resolved at request time, not instantiation time
* here we update the `child`'s `JoinField` after already creating the index request for `child`
*/
child.MyJoinField = JoinField.Link<MyChild>(parentId: "something-else");
Expand Down
Expand Up @@ -52,15 +52,14 @@ public MyPluginProperty(string name, string language)
public bool Numeric { get; set; }
}


[U]
public void InjectACustomIPropertyImplementation()
{
/**
* `PropertyNameAttribute` can be used to mark properties that should be serialized. Without this attribute,
* NEST won't pick up the property for serialization.
*
* Now that we have our own `IProperty` implementation we can add it to our propertes mapping when creating an index
* Now that we have our own `IProperty` implementation we can add it to our properties mapping when creating an index
*/
var createIndexResponse = client.Indices.Create("myindex", c => c
.Map<Project>(m => m
Expand Down
2 changes: 1 addition & 1 deletion src/Tests/Tests/ClientConcepts/LowLevel/Lifetimes.doc.cs
Expand Up @@ -73,7 +73,7 @@ protected override void DisposeManagedResources()
}

/**
* `ConnectionSettings`, `IConnectionPool` and `IConnection` all explictily implement `IDisposable`
* `ConnectionSettings`, `IConnectionPool` and `IConnection` all explicitly implement `IDisposable`
*/
[U] public void InitialDisposeState()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Tests/Tests/ClientConcepts/LowLevel/PostData.doc.cs
Expand Up @@ -81,7 +81,7 @@ public PostingData()
/**[float]
* === Other types of PostData
*
* You can also pass the following objects directy to the low level client.
* You can also pass the following objects directly to the low level client.
*
* - A Serializable `object`
* - A collection of `object` as multi line json
Expand Down
2 changes: 1 addition & 1 deletion src/Tests/Tests/CommonOptions/TimeUnit/TimeUnits.doc.cs
Expand Up @@ -268,7 +268,7 @@ private class DoubleParsingTestCases : List<Tuple<double, TimeSpan, string>>
* ==== Units of Time
*
* Where Units of Time can be specified as a union of either a `DateInterval` or `Time`,
* a `DateInterval` or `Time` may be passed which will be implicity converted to a
* a `DateInterval` or `Time` may be passed which will be implicitly converted to a
* `Union<DateInterval, Time>`, the serialized form of which represents the initial value
* passed
*/
Expand Down

0 comments on commit fb24a3d

Please sign in to comment.