Skip to content

Commit a9cd487

Browse files
committed
Correct spellings
1 parent 05d7e9f commit a9cd487

File tree

14 files changed

+157
-30
lines changed

14 files changed

+157
-30
lines changed

src/Tests/ClientConcepts/ConnectionPooling/BuildingBlocks/DateTimeProviders.Doc.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ [U] public void DefaultNowBehaviour()
2929
[U] public void DeadTimeoutCalculation()
3030
{
3131
var dateTimeProvider = DateTimeProvider.Default;
32-
/**
33-
* The default timeout calculation is: `min(timeout * 2 ^ (attempts * 0.5 -1), maxTimeout)`, where the
32+
/**
33+
* The default timeout calculation is: `min(timeout * 2 ^ (attempts * 0.5 -1), maxTimeout)`, where the
3434
* default values for `timeout` and `maxTimeout` are
3535
*/
3636
var timeout = TimeSpan.FromMinutes(1);
@@ -40,8 +40,8 @@ [U] public void DeadTimeoutCalculation()
4040
* Plotting these defaults looks as followed:
4141
*
4242
*[[timeout]]
43-
*.Default formula, y-axis time in minutes, x-axis number of attempts to revive
44-
*image::timeoutplot.png[dead timeout]
43+
*.Default formula, x-axis number of attempts to revive, y-axis time in minutes
44+
*image::timeoutplot.png[dead timeout]
4545
*
4646
* The goal here is that whenever a node is resurrected and is found to still be offline, we send it
4747
* _back to the doghouse_ for an ever increasingly long period, until we hit a bounded maximum.
@@ -52,7 +52,7 @@ [U] public void DeadTimeoutCalculation()
5252

5353
foreach (var increasedTimeout in timeouts.Take(10))
5454
increasedTimeout.Should().BeWithin(maxTimeout);
55-
55+
5656
}
5757

5858
}

src/Tests/ClientConcepts/ConnectionPooling/Pinging/FirstUsage.doc.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ await audit.TraceCalls(
7777
} }
7878
},
7979
/** The 2nd call does a ping on 9201 because its used for the first time.
80-
* It fails and so we ping 9202 which also fails. We then ping 9203 becuase
80+
* It fails and so we ping 9202 which also fails. We then ping 9203 because
8181
* we haven't used it before and it succeeds */
8282
new ClientCall {
8383
{ PingFailure, 9201},

src/Tests/ClientConcepts/ConnectionPooling/RoundRobin/RoundRobin.doc.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class RoundRobin
1919
/** === GetNext
2020
* `GetNext` is implemented in a lock free thread safe fashion, meaning each callee gets returned its own cursor to advance
2121
* over the internal list of nodes. This to guarantee each request that needs to fall over tries all the nodes without
22-
* suffering from noisy neighboors advancing a global cursor.
22+
* suffering from noisy neighbours advancing a global cursor.
2323
*/
2424
protected int NumberOfNodes = 10;
2525

src/Tests/ClientConcepts/ConnectionPooling/RoundRobin/SkipDeadNodes.doc.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class SkippingDeadNodes
1919
* === GetNext
2020
* GetNext is implemented in a lock free thread safe fashion, meaning each callee gets returned its own cursor to advance
2121
* over the internal list of nodes. This to guarantee each request that needs to fall over tries all the nodes without
22-
* suffering from noisy neighboors advancing a global cursor.
22+
* suffering from noisy neighbours advancing a global cursor.
2323
*/
2424
protected int NumberOfNodes = 3;
2525

src/Tests/ClientConcepts/ConnectionPooling/Sniffing/OnConnectionFailure.doc.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ [U] public async Task DoesASniffAfterConnectionFailure()
3131
.ClientCalls(r => r.SucceedAlways())
3232
.ClientCalls(r => r.OnPort(9201).Fails(Once))
3333
/**
34-
* When the call fails on 9201 the sniff succeeds and returns a new cluster of healty nodes
34+
* When the call fails on 9201 the sniff succeeds and returns a new cluster of healthy nodes
3535
* this cluster only has 3 nodes and the known masters are 9200 and 9202 but a search on 9201
3636
* still fails once
3737
*/

src/Tests/ClientConcepts/ConnectionPooling/Sniffing/OnStaleClusterState.doc.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public class OnStaleClusterState
1313
/**== Sniffing periodically
1414
*
1515
* Connection pools that return true for `SupportsReseeding` can be configured to sniff periodically.
16-
* In addition to sniffing on startup and sniffing on failures, sniffing periodically can benefit scenerio's where
16+
* In addition to sniffing on startup and sniffing on failures, sniffing periodically can benefit scenarios where
1717
* clusters are often scaled horizontally during peak hours. An application might have a healthy view of a subset of the nodes
1818
* but without sniffing periodically it will never find the nodes that have been added to help out with load
1919
*/

src/Tests/ClientConcepts/ConnectionPooling/Sticky/SkipDeadNodes.doc.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public void EachViewSeesNextButSkipsTheDeadNode()
4646
node = pool.CreateView().First();
4747
node.Uri.Port.Should().Be(9201);
4848
}
49-
/** After we marke the first node alive again we expect it to be hit again*/
49+
/** After we mark the first node alive again we expect it to be hit again*/
5050
seeds.First().MarkAlive();
5151
for (var i = 0; i < 20; i++)
5252
{

src/Tests/ClientConcepts/HighLevel/Inference/DocumentPaths.doc.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ public class DocumentPaths
1010
/**== Document Paths
1111
*
1212
* Many API's in Elasticsearch describe a path to a document. In NEST, besides generating a constructor that takes
13-
* and Index, Type and Id seperately, we also generate a constructor taking a `DocumentPath` that allows you to describe the path
14-
* to your document more succintly
13+
* and Index, Type and Id separately, we also generate a constructor taking a `DocumentPath` that allows you to describe the path
14+
* to your document more succinctly
1515
*/
1616

1717
/** === Creating new instances */

src/Tests/ClientConcepts/HighLevel/Inference/FeaturesInference.doc.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ [U] public void Serializes()
2929
public void ImplicitConversion()
3030
{
3131
/**
32-
* Here we new an GET index elasticsearch request whichs takes Indices and Features.
32+
* Here we new an GET index elasticsearch request which takes Indices and Features.
3333
* Notice how we can use the Feature enum directly.
3434
*/
3535
var request = new GetIndexRequest(All, Feature.Settings);

src/Tests/ClientConcepts/HighLevel/Inference/FieldInference.doc.cs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ namespace Tests.ClientConcepts.HighLevel.Inference
2020
public class FieldInference
2121
{
2222
/**== Field Inference
23-
*
23+
*
2424
* Several places in the Elasticsearch API expect the path to a field from your original source document as a string.
25-
* NEST allows you to use C# expressions to strongly type these field path strings.
25+
* NEST allows you to use C# expressions to strongly type these field path strings.
2626
*
2727
* These expressions are assigned to a type called `Field` and there are several ways to create an instance of one
2828
*/
@@ -133,7 +133,7 @@ public void UsingStaticPropertyField()
133133
/** You can specify boosts in the field using a string */
134134
fieldString = "name^2.1";
135135
fieldString.Boost.Should().Be(2.1);
136-
136+
137137
/** As well as using `Nest.Infer.Field` */
138138
fieldExpression = Field<Project>(p => p.Name, 2.1);
139139
Expect("name^2.1")
@@ -229,7 +229,7 @@ public void ComplexFieldNameExpressions()
229229
Field<Project>(p => p.Metadata[variable].Created.Suffix(suffix)));
230230
}
231231

232-
/**
232+
/**
233233
* Suffixes can also be appended to expressions using `.AppendSuffix()`. This is useful in cases where you want to apply the same suffix
234234
* to a list of fields.
235235
*/
@@ -246,7 +246,7 @@ public void AppendingSuffixToExpressions()
246246
};
247247

248248
/** and we want to append the suffix "raw" to each */
249-
var fieldExpressions =
249+
var fieldExpressions =
250250
expressions.Select<Expression<Func<Project, object>>, Field>(e => e.AppendSuffix("raw")).ToList();
251251

252252
Expect("name.raw").WhenSerializing(fieldExpressions[0]);
@@ -256,7 +256,7 @@ public void AppendingSuffixToExpressions()
256256
}
257257

258258
/**=== Attribute based naming
259-
*
259+
*
260260
* Using NEST's property attributes you can specify a new name for the properties
261261
*/
262262
public class BuiltIn
@@ -270,7 +270,7 @@ public void BuiltInAnnotiatons()
270270
Expect("naam").WhenSerializing(Field<BuiltIn>(p => p.Name));
271271
}
272272

273-
/**
273+
/**
274274
* Starting with NEST 2.x, we also ask the serializer if it can resolve a property to a name.
275275
* Here we ask the default `JsonNetSerializer` to resolve a property name and it takes
276276
* the `JsonPropertyAttribute` into account
@@ -286,7 +286,7 @@ public void SerializerSpecificAnnotations()
286286
Expect("nameInJson").WhenSerializing(Field<SerializerSpecific>(p => p.Name));
287287
}
288288

289-
/**
289+
/**
290290
* If both a NEST property attribute and a serializer specific attribute are present on a property,
291291
* **NEST attributes take precedence**
292292
*/
@@ -330,7 +330,7 @@ public void ExpressionsAreCachedButSeeDifferentTypes()
330330
var fieldNameOnB = client.Infer.Field(Field<B>(p => p.C.Name));
331331

332332
/**
333-
* Here we have to similary shaped expressions on coming from A and on from B
333+
* Here we have two similarly shaped expressions, one coming from A and one from B
334334
* that will resolve to the same field name, as expected
335335
*/
336336

@@ -355,7 +355,7 @@ public void ExpressionsAreCachedButSeeDifferentTypes()
355355
fieldNameOnA.Should().Be("d.name");
356356
fieldNameOnB.Should().Be("c.name");
357357

358-
/** however we didn't break inferrence on the first client instance using its separate connection settings */
358+
/** however we didn't break inference on the first client instance using its separate connection settings */
359359
fieldNameOnA = client.Infer.Field(Field<A>(p => p.C.Name));
360360
fieldNameOnB = client.Infer.Field(Field<B>(p => p.C.Name));
361361

@@ -369,7 +369,7 @@ public void ExpressionsAreCachedButSeeDifferentTypes()
369369
*
370370
* . A hard rename of the property on connection settings using `.Rename()`
371371
* . A NEST property mapping
372-
* . Ask the serializer if the property has a verbatim value e.g it has an explicit JsonPropery attribute.
372+
* . Ask the serializer if the property has a verbatim value e.g it has an explicit JsonProperty attribute.
373373
* . Pass the MemberInfo's Name to the DefaultFieldNameInferrer which by default camelCases
374374
*
375375
* The following example class will demonstrate this precedence
@@ -393,7 +393,7 @@ class Precedence
393393
public string DefaultFieldNameInferrer { get; set; } //<5> We are going to register a DefaultFieldNameInferrer on ConnectionSettings that will uppercase all properties.
394394
}
395395

396-
/**
396+
/**
397397
* Here we create a custom serializer that renames any property named `AskSerializer` to `ask`
398398
*/
399399
class CustomSerializer : JsonNetSerializer

0 commit comments

Comments
 (0)