fix spellings

russcam · russcam · commit 754bc1d51c0b · 2016-04-23T00:04:49.000+10:00
diff --git a/docs/asciidoc/client-concepts/connection-pooling/building-blocks/date-time-providers.asciidoc b/docs/asciidoc/client-concepts/connection-pooling/building-blocks/date-time-providers.asciidoc
@@ -7,7 +7,7 @@
 [[date-time-providers]]
 == Date time providers
 
-Not typically something you'll have to pass to the client but all calls to `System.DateTime.UtcNow` 
+Not typically something you'll have to pass to the client but all calls to `System.DateTime.UtcNow`
 in the client have been abstracted by `IDateTimeProvider`. This allows us to unit test timeouts and cluster failover
 without being bound to wall clock time as calculated by using `System.DateTime.UtcNow` directly.
 
@@ -32,7 +32,7 @@ to provide a custom implementation for.
 var dateTimeProvider = DateTimeProvider.Default;
 ----
 
-The default timeout calculation is: `min(timeout * 2 ^ (attempts * 0.5 -1), maxTimeout)`, where the 
+The default timeout calculation is: `min(timeout * 2 ^ (attempts * 0.5 -1), maxTimeout)`, where the
 default values for `timeout` and `maxTimeout` are
 
 [source,csharp]
@@ -45,7 +45,7 @@ var maxTimeout = TimeSpan.FromMinutes(30);
 Plotting these defaults looks as followed:
 
 [[timeout]]
-.Default formula, x-axis time in minutes, y-axis number of attempts to revive
+.Default formula, x-axis number of attempts to revive, y-axis time in minutes
 image::timeoutplot.png[dead timeout]
 
 The goal here is that whenever a node is resurrected and is found to still be offline, we send it_back to the doghouse_ for an ever increasingly long period, until we hit a bounded maximum.
diff --git a/docs/asciidoc/client-concepts/connection-pooling/pinging/first-usage.asciidoc b/docs/asciidoc/client-concepts/connection-pooling/pinging/first-usage.asciidoc
@@ -67,7 +67,7 @@ var audit = new Auditor(() => Framework.Cluster
 The first call goes to 9200 which succeeds 
 
 The 2nd call does a ping on 9201 because its used for the first time.
-It fails and so we ping 9202 which also fails. We then ping 9203 becuase
+It fails and so we ping 9202 which also fails. We then ping 9203 because
 we haven't used it before and it succeeds 
 
 Finally we assert that the connectionpool has two nodes that are marked as dead 
diff --git a/docs/asciidoc/client-concepts/connection-pooling/round-robin/round-robin.asciidoc b/docs/asciidoc/client-concepts/connection-pooling/round-robin/round-robin.asciidoc
@@ -14,7 +14,7 @@ round robin over the `live` nodes to evenly distribute request load over all kno
 
 `GetNext` is implemented in a lock free thread safe fashion, meaning each callee gets returned its own cursor to advance
 over the internal list of nodes. This to guarantee each request that needs to fall over tries all the nodes without
-suffering from noisy neighboors advancing a global cursor.
+suffering from noisy neighbours advancing a global cursor.
 
 [source,csharp]
 ----
diff --git a/docs/asciidoc/client-concepts/connection-pooling/round-robin/skip-dead-nodes.asciidoc b/docs/asciidoc/client-concepts/connection-pooling/round-robin/skip-dead-nodes.asciidoc
@@ -13,7 +13,7 @@ When selecting nodes the connection pool will try and skip all the nodes that ar
 
 GetNext is implemented in a lock free thread safe fashion, meaning each callee gets returned its own cursor to advance
 over the internal list of nodes. This to guarantee each request that needs to fall over tries all the nodes without
-suffering from noisy neighboors advancing a global cursor.
+suffering from noisy neighbours advancing a global cursor.
 
 [source,csharp]
 ----
diff --git a/docs/asciidoc/client-concepts/connection-pooling/sniffing/on-connection-failure.asciidoc b/docs/asciidoc/client-concepts/connection-pooling/sniffing/on-connection-failure.asciidoc
@@ -17,7 +17,7 @@ Here we seed our connection with 5 known nodes 9200-9204 of which we think
 9202, 9203, 9204 are master eligible nodes. Our virtualized cluster will throw once when doing
 a search on 9201. This should a sniff to be kicked off.
 
-When the call fails on 9201 the sniff succeeds and returns a new cluster of healty nodes
+When the call fails on 9201 the sniff succeeds and returns a new cluster of healthy nodes
 this cluster only has 3 nodes and the known masters are 9200 and 9202 but a search on 9201
 still fails once
 
diff --git a/docs/asciidoc/client-concepts/connection-pooling/sniffing/on-stale-cluster-state.asciidoc b/docs/asciidoc/client-concepts/connection-pooling/sniffing/on-stale-cluster-state.asciidoc
@@ -8,7 +8,7 @@
 == Sniffing periodically
 
 Connection pools that return true for `SupportsReseeding` can be configured to sniff periodically.
-In addition to sniffing on startup and sniffing on failures, sniffing periodically can benefit scenerio's where
+In addition to sniffing on startup and sniffing on failures, sniffing periodically can benefit scenarios where
 clusters are often scaled horizontally during peak hours. An application might have a healthy view of a subset of the nodes
 but without sniffing periodically it will never find the nodes that have been added to help out with load
 
diff --git a/docs/asciidoc/client-concepts/high-level/inference/document-paths.asciidoc b/docs/asciidoc/client-concepts/high-level/inference/document-paths.asciidoc
@@ -8,8 +8,8 @@
 == Document Paths
 
 Many API's in Elasticsearch describe a path to a document. In NEST, besides generating a constructor that takes
-and Index, Type and Id seperately, we also generate a constructor taking a `DocumentPath` that allows you to describe the path
-to your document more succintly
+and Index, Type and Id separately, we also generate a constructor taking a `DocumentPath` that allows you to describe the path
+to your document more succinctly
 
 === Creating new instances 
 
diff --git a/docs/asciidoc/client-concepts/high-level/inference/features-inference.asciidoc b/docs/asciidoc/client-concepts/high-level/inference/features-inference.asciidoc
@@ -25,7 +25,7 @@ Expect("_mappings,_aliases")
 
 === Implicit conversion
 
-Here we instantiate a GET index request whichs takes two features, settings and warmers.
+Here we instantiate a GET index request which takes two features, settings and warmers.
 Notice how we can use the `Feature` enum directly.
 
 [source,csharp]
diff --git a/docs/asciidoc/client-concepts/high-level/inference/field-inference.asciidoc b/docs/asciidoc/client-concepts/high-level/inference/field-inference.asciidoc
@@ -64,7 +64,7 @@ to prevent ambiguity over which property should be used when resolving the path
 === Implicit Conversion
 
 As you can see from the previous examples, using the constructor is rather involved and cumbersome.
-Becuase of this, you can also implicitly convert strings and expressions to a `Field` 
+Because of this, you can also implicitly convert strings and expressions to a `Field` 
 
 [source,csharp]
 ----
@@ -411,7 +411,7 @@ var fieldNameOnA = client.Infer.Field(Field<A>(p => p.C.Name));
 var fieldNameOnB = client.Infer.Field(Field<B>(p => p.C.Name));
 ----
 
-Here we have to similary shaped expressions on coming from A and on from B
+Here we have two similarly shaped expressions, one coming from A and one from B
 that will resolve to the same field name, as expected
 
 [source,csharp]
@@ -444,7 +444,7 @@ fieldNameOnA.Should().Be("d.name");
 fieldNameOnB.Should().Be("c.name");
 ----
 
-however we didn't break inferrence on the first client instance using its separate connection settings 
+however we didn't break inference on the first client instance using its separate connection settings 
 
 [source,csharp]
 ----
@@ -466,7 +466,7 @@ To wrap up, the precedence in which field names are inferred is:
 
 . A NEST property mapping
 
-. Ask the serializer if the property has a verbatim value e.g it has an explicit JsonPropery attribute.
+. Ask the serializer if the property has a verbatim value e.g it has an explicit JsonProperty attribute.
 
 . Pass the MemberInfo's Name to the DefaultFieldNameInferrer which by default camelCases
 
diff --git a/docs/asciidoc/client-concepts/high-level/inference/index-name-inference.asciidoc b/docs/asciidoc/client-concepts/high-level/inference/index-name-inference.asciidoc
@@ -14,7 +14,7 @@ NEST has a number of ways in which an index name can be specified
 
 === Default Index name on ConnectionSettings
 
-A default index name can be specified on `ConnectionSettings` usinf `.DefaultIndex()`.
+A default index name can be specified on `ConnectionSettings` using `.DefaultIndex()`.
 This is the default index name to use when no other index name can be resolved for a request
 
 [source,csharp]
diff --git a/docs/asciidoc/client-concepts/high-level/inference/indices-paths.asciidoc b/docs/asciidoc/client-concepts/high-level/inference/indices-paths.asciidoc
@@ -61,7 +61,7 @@ var invalidSingleString = Nest.Indices.Index("name1, name2"); <4>
 
 <2> specifying multiple indices using strings
 
-<3> speciying multiple using types
+<3> specifying multiple using types
 
 <4> an **invalid** single index name
 
diff --git a/docs/asciidoc/client-concepts/high-level/mapping/auto-map.asciidoc b/docs/asciidoc/client-concepts/high-level/mapping/auto-map.asciidoc
@@ -247,7 +247,7 @@ Expect(expected).WhenSerializing((ICreateIndexRequest)descriptor);
 
 In most cases, you'll want to map more than just the vanilla datatypes and also provide
 various options for your properties (analyzer to use, whether to enable doc_values, etc...).
-In that case, it's possible to use `.AutoMap()` in conjuction with explicitly mapped properties.
+In that case, it's possible to use `.AutoMap()` in conjunction with explicitly mapped properties.
 
 Here we are using `.AutoMap()` to automatically map our company type, but then we're
 overriding our employee property and making it a `nested` type, since by default,`.AutoMap()` will infer objects as `object`.
diff --git a/docs/asciidoc/code-standards/naming-conventions.asciidoc b/docs/asciidoc/code-standards/naming-conventions.asciidoc
@@ -130,33 +130,80 @@ requests.Except(responses).Should().BeEmpty();
 
 [source,csharp]
 ----
+var nestAssembly = typeof(IElasticClient).Assembly();
+
 var exceptions = new List<Type>
 {
-    typeof(IElasticClient).Assembly().GetType("Elasticsearch.Net.DotNetCoreTypeExtensions"),
+    nestAssembly.GetType("Elasticsearch.Net.DotNetCoreTypeExtensions"),
     typeof(AggregationWalker),
     typeof(AggregationVisitor),
     typeof(IAggregationVisitor),
-    typeof(IElasticClient).Assembly().GetType("System.AssemblyVersionInformation")
+    nestAssembly.GetType("System.AssemblyVersionInformation"),
+#if DOTNETCORE
+    typeof(SynchronizedCollection<>),
+    nestAssembly.GetType("System.ComponentModel.Browsable")
+#endif
 };
 
-var types = typeof(IElasticClient).Assembly().GetTypes();
+var types = nestAssembly.GetTypes();
 
 var typesNotInNestNamespace = types
     .Where(t => !exceptions.Contains(t))
     .Where(t => t.Namespace != "Nest")
+    .Where(t => !t.Name.StartsWith("<"))
+    .Where(t => IsValidTypeNameOrIdentifier(t.Name, true))
     .ToList();
 
 typesNotInNestNamespace.Should().BeEmpty();
 ----
 
 [source,csharp]
 ----
-var types = typeof(IElasticLowLevelClient).Assembly().GetTypes();
+var elasticsearchNetAssembly = typeof(IElasticLowLevelClient).Assembly();
 
-var typesNotInNestNamespace = types
+var exceptions = new List<Type>
+{
+    elasticsearchNetAssembly.GetType("System.AssemblyVersionInformation"),
+    elasticsearchNetAssembly.GetType("System.FormattableString"),
+    elasticsearchNetAssembly.GetType("System.Runtime.CompilerServices.FormattableStringFactory"),
+    elasticsearchNetAssembly.GetType("System.Runtime.CompilerServices.FormattableStringFactory"),
+    elasticsearchNetAssembly.GetType("Purify.Purifier"),
+    elasticsearchNetAssembly.GetType("Purify.Purifier+IPurifier"),
+    elasticsearchNetAssembly.GetType("Purify.Purifier+PurifierDotNet"),
+    elasticsearchNetAssembly.GetType("Purify.Purifier+PurifierMono"),
+    elasticsearchNetAssembly.GetType("Purify.Purifier+UriInfo"),
+#if DOTNETCORE
+    elasticsearchNetAssembly.GetType("System.ComponentModel.Browsable")
+#endif
+};
+
+var types = elasticsearchNetAssembly.GetTypes();
+
+var typesNotIElasticsearchNetNamespace = types
+    .Where(t => !exceptions.Contains(t))
     .Where(t => t.Namespace != "Elasticsearch.Net")
+    .Where(t => !t.Name.StartsWith("<"))
+    .Where(t => IsValidTypeNameOrIdentifier(t.Name, true))
     .ToList();
 
-typesNotInNestNamespace.Should().BeEmpty();
+typesNotIElasticsearchNetNamespace.Should().BeEmpty();
+----
+
+[source,csharp]
+----
+bool nextMustBeStartChar = true;
+
+var character = value[index];
+
+var unicodeCategory = char.GetUnicodeCategory(character);
+
+nextMustBeStartChar = false;
+
+nextMustBeStartChar = false;
+----
+
+[source,csharp]
+----
+nextMustBeStartChar = true;
 ----
 
diff --git a/docs/asciidoc/query-dsl/term-level/terms/terms-query-usage.asciidoc b/docs/asciidoc/query-dsl/term-level/terms/terms-query-usage.asciidoc
@@ -60,7 +60,7 @@ new TermsQuery
 
 [[single-term-terms-query]]
 [float]
-== Single term Terms Query 
+== Single term Terms Query
 
 === Fluent DSL Example
 
diff --git a/src/Tests/ClientConcepts/ConnectionPooling/BuildingBlocks/DateTimeProviders.Doc.cs b/src/Tests/ClientConcepts/ConnectionPooling/BuildingBlocks/DateTimeProviders.Doc.cs
@@ -9,8 +9,8 @@ namespace Tests.ClientConcepts.ConnectionPooling.BuildingBlocks
 	public class DateTimeProviders
 	{
 		/**== Date time providers
-		 * 
-		 * Not typically something you'll have to pass to the client but all calls to `System.DateTime.UtcNow` 
+		 *
+		 * Not typically something you'll have to pass to the client but all calls to `System.DateTime.UtcNow`
 		 * in the client have been abstracted by `IDateTimeProvider`. This allows us to unit test timeouts and cluster failover
 		 * without being bound to wall clock time as calculated by using `System.DateTime.UtcNow` directly.
 		 */
@@ -29,8 +29,8 @@ [U] public void DefaultNowBehaviour()
 		[U] public void DeadTimeoutCalculation()
 		{
 			var dateTimeProvider = DateTimeProvider.Default;
-			/**  
-			* The default timeout calculation is: `min(timeout * 2 ^ (attempts * 0.5 -1), maxTimeout)`, where the 
+			/**
+			* The default timeout calculation is: `min(timeout * 2 ^ (attempts * 0.5 -1), maxTimeout)`, where the
 			* default values for `timeout` and `maxTimeout` are
 			*/
 			var timeout = TimeSpan.FromMinutes(1);
@@ -40,8 +40,8 @@ [U] public void DeadTimeoutCalculation()
 			* Plotting these defaults looks as followed:
 			*
 			*[[timeout]]
-			*.Default formula, x-axis time in minutes, y-axis number of attempts to revive
-			*image::timeoutplot.png[dead timeout]	
+			*.Default formula, x-axis number of attempts to revive, y-axis time in minutes
+			*image::timeoutplot.png[dead timeout]
 			*
 			* The goal here is that whenever a node is resurrected and is found to still be offline, we send it
 			* _back to the doghouse_ for an ever increasingly long period, until we hit a bounded maximum.
@@ -52,7 +52,7 @@ [U] public void DeadTimeoutCalculation()
 
 			foreach (var increasedTimeout in timeouts.Take(10))
 				increasedTimeout.Should().BeWithin(maxTimeout);
-			
+
 		}
 
 	}
diff --git a/src/Tests/ClientConcepts/ConnectionPooling/Pinging/FirstUsage.doc.cs b/src/Tests/ClientConcepts/ConnectionPooling/Pinging/FirstUsage.doc.cs
@@ -77,7 +77,7 @@ await audit.TraceCalls(
 					} }
 				},
 				/** The 2nd call does a ping on 9201 because its used for the first time.
-				* It fails and so we ping 9202 which also fails. We then ping 9203 becuase
+				* It fails and so we ping 9202 which also fails. We then ping 9203 because
 				* we haven't used it before and it succeeds */
 				new ClientCall {
 					{ PingFailure, 9201},
diff --git a/src/Tests/ClientConcepts/ConnectionPooling/RoundRobin/RoundRobin.doc.cs b/src/Tests/ClientConcepts/ConnectionPooling/RoundRobin/RoundRobin.doc.cs
@@ -19,7 +19,7 @@ public class RoundRobin
 		/** === GetNext
 		* `GetNext` is implemented in a lock free thread safe fashion, meaning each callee gets returned its own cursor to advance
 		* over the internal list of nodes. This to guarantee each request that needs to fall over tries all the nodes without
-		* suffering from noisy neighboors advancing a global cursor.
+		* suffering from noisy neighbours advancing a global cursor.
 		*/
 		protected int NumberOfNodes = 10;
 
diff --git a/src/Tests/ClientConcepts/ConnectionPooling/RoundRobin/SkipDeadNodes.doc.cs b/src/Tests/ClientConcepts/ConnectionPooling/RoundRobin/SkipDeadNodes.doc.cs
@@ -19,7 +19,7 @@ public class SkippingDeadNodes
 		* === GetNext
 		* GetNext is implemented in a lock free thread safe fashion, meaning each callee gets returned its own cursor to advance
 		* over the internal list of nodes. This to guarantee each request that needs to fall over tries all the nodes without
-		* suffering from noisy neighboors advancing a global cursor.
+		* suffering from noisy neighbours advancing a global cursor.
 		*/
 		protected int NumberOfNodes = 3;
 
diff --git a/src/Tests/ClientConcepts/ConnectionPooling/Sniffing/OnConnectionFailure.doc.cs b/src/Tests/ClientConcepts/ConnectionPooling/Sniffing/OnConnectionFailure.doc.cs
@@ -31,7 +31,7 @@ [U] public async Task DoesASniffAfterConnectionFailure()
 				.ClientCalls(r => r.SucceedAlways())
 				.ClientCalls(r => r.OnPort(9201).Fails(Once))
 				/**
-				* When the call fails on 9201 the sniff succeeds and returns a new cluster of healty nodes
+				* When the call fails on 9201 the sniff succeeds and returns a new cluster of healthy nodes
 				* this cluster only has 3 nodes and the known masters are 9200 and 9202 but a search on 9201
 				* still fails once
 				*/
diff --git a/src/Tests/ClientConcepts/ConnectionPooling/Sniffing/OnStaleClusterState.doc.cs b/src/Tests/ClientConcepts/ConnectionPooling/Sniffing/OnStaleClusterState.doc.cs
@@ -13,7 +13,7 @@ public class OnStaleClusterState
 		/**== Sniffing periodically
 		*
 		* Connection pools that return true for `SupportsReseeding` can be configured to sniff periodically.
-		* In addition to sniffing on startup and sniffing on failures, sniffing periodically can benefit scenerio's where
+		* In addition to sniffing on startup and sniffing on failures, sniffing periodically can benefit scenarios where
 		* clusters are often scaled horizontally during peak hours. An application might have a healthy view of a subset of the nodes
 		* but without sniffing periodically it will never find the nodes that have been added to help out with load
 		*/
diff --git a/src/Tests/ClientConcepts/HighLevel/Inference/DocumentPaths.doc.cs b/src/Tests/ClientConcepts/HighLevel/Inference/DocumentPaths.doc.cs
@@ -10,8 +10,8 @@ public class DocumentPaths
 		/**== Document Paths
 		 *
 		 * Many API's in Elasticsearch describe a path to a document. In NEST, besides generating a constructor that takes
-		 * and Index, Type and Id seperately, we also generate a constructor taking a `DocumentPath` that allows you to describe the path
-		 * to your document more succintly
+		 * and Index, Type and Id separately, we also generate a constructor taking a `DocumentPath` that allows you to describe the path
+		 * to your document more succinctly
 		 */
 
 		/** === Creating new instances */
diff --git a/src/Tests/ClientConcepts/HighLevel/Inference/FeaturesInference.doc.cs b/src/Tests/ClientConcepts/HighLevel/Inference/FeaturesInference.doc.cs
@@ -29,7 +29,7 @@ [U] public void Serializes()
 		public void ImplicitConversion()
 		{
 			/** === Implicit conversion
-			* Here we instantiate a GET index request whichs takes two features, settings and warmers.
+			* Here we instantiate a GET index request which takes two features, settings and warmers.
 			* Notice how we can use the `Feature` enum directly.
 			*/
 			var request = new GetIndexRequest(All, Feature.Settings | Feature.Warmers);
diff --git a/src/Tests/ClientConcepts/HighLevel/Inference/FieldInference.doc.cs b/src/Tests/ClientConcepts/HighLevel/Inference/FieldInference.doc.cs
@@ -114,7 +114,7 @@ public void ShouldSetOneProperty()
 
 		/**=== Implicit Conversion
 		* As you can see from the previous examples, using the constructor is rather involved and cumbersome.
-		* Becuase of this, you can also implicitly convert strings and expressions to a `Field` */
+		* Because of this, you can also implicitly convert strings and expressions to a `Field` */
 		[U]
 		public void ImplicitConversion()
 		{
@@ -371,7 +371,7 @@ public void ExpressionsAreCachedButSeeDifferentTypes()
 			var fieldNameOnB = client.Infer.Field(Field<B>(p => p.C.Name));
 
 			/**
-			* Here we have to similary shaped expressions on coming from A and on from B
+			* Here we have two similarly shaped expressions, one coming from A and one from B
 			* that will resolve to the same field name, as expected
 			*/
 
@@ -396,7 +396,7 @@ public void ExpressionsAreCachedButSeeDifferentTypes()
 			fieldNameOnA.Should().Be("d.name");
 			fieldNameOnB.Should().Be("c.name");
 
-			/** however we didn't break inferrence on the first client instance using its separate connection settings */
+			/** however we didn't break inference on the first client instance using its separate connection settings */
 			fieldNameOnA = client.Infer.Field(Field<A>(p => p.C.Name));
 			fieldNameOnB = client.Infer.Field(Field<B>(p => p.C.Name));
 
@@ -410,7 +410,7 @@ public void ExpressionsAreCachedButSeeDifferentTypes()
 		*
 		* . A hard rename of the property on connection settings using `.Rename()`
 		* . A NEST property mapping
-		* . Ask the serializer if the property has a verbatim value e.g it has an explicit JsonPropery attribute.
+		* . Ask the serializer if the property has a verbatim value e.g it has an explicit JsonProperty attribute.
 		* . Pass the MemberInfo's Name to the DefaultFieldNameInferrer which by default camelCases
 		*
 		* The following example class will demonstrate this precedence
diff --git a/src/Tests/ClientConcepts/HighLevel/Inference/IndexNameInference.doc.cs b/src/Tests/ClientConcepts/HighLevel/Inference/IndexNameInference.doc.cs
diff --git a/src/Tests/ClientConcepts/HighLevel/Inference/IndicesPaths.doc.cs b/src/Tests/ClientConcepts/HighLevel/Inference/IndicesPaths.doc.cs
diff --git a/src/Tests/ClientConcepts/HighLevel/Mapping/AutoMap.doc.cs b/src/Tests/ClientConcepts/HighLevel/Mapping/AutoMap.doc.cs
