Update documentation

Author: russcam

docs/code-standards/descriptors.asciidoc

@@ -13,8 +13,8 @@ Every descriptor should inherit from `DescriptorBase`, this hides object members
 ----
 var notDescriptors = new[] { typeof(ClusterProcessOpenFileDescriptors).Name, "DescriptorForAttribute" };
 var descriptors = from t in typeof(DescriptorBase<,>).Assembly().Types()
-                  where t.IsClass() 
-                    && t.Name.Contains("Descriptor") 
+                  where t.IsClass()
+                    && t.Name.Contains("Descriptor")
                     && !notDescriptors.Contains(t.Name)
                     && !t.GetInterfaces().Any(i => i == typeof(IDescriptor))
                   select t.FullName;
@@ -59,3 +59,74 @@ var selectorMethods =
 selectorMethods.Should().BeEmpty();
 ----
 
+Descriptor methods that assign to a nullable bool property should accept
+a nullable bool with a default value
+
+[source,csharp]
+----
+var queries =
+    from t in typeof(IQuery).Assembly().Types()
+    where t.IsInterface() && typeof(IQuery).IsAssignableFrom(t)
+    where t.GetProperties().Any(p => p.PropertyType == typeof(bool?))
+    select t;
+
+var descriptors =
+    from t in typeof(DescriptorBase<,>).Assembly().Types()
+    where t.IsClass() && typeof(IDescriptor).IsAssignableFrom(t)
+    where t.GetInterfaces().Intersect(queries).Any()
+    select t;
+
+var breakingDescriptors = new List<string>();
+
+var parameterlessMethods = new List<MethodInfo>
+{
+    typeof(BoolQueryDescriptor<>).GetMethod(nameof(BoolQueryDescriptor<object>.DisableCoord))
+};
+
+var nonDefaultValueMethods = new List<MethodInfo>
+{
+    typeof(SpanNearQueryDescriptor<>).GetMethod(nameof(SpanNearQueryDescriptor<object>.CollectPayloads)),
+    typeof(SpanNearQueryDescriptor<>).GetMethod(nameof(SpanNearQueryDescriptor<object>.InOrder)),
+};
+----
+
+[source,csharp]
+----
+foreach (var query in queries)
+{
+    var descriptor = descriptors.First(d => query.IsAssignableFrom(d));
+    foreach (var boolProperty in query.GetProperties().Where(p => p.PropertyType == typeof(bool?)))
+    {
+        var descriptorMethod = descriptor.GetMethod(boolProperty.Name);
+        if (descriptorMethod == null)
+            throw new Exception($"No method for property {boolProperty.Name} on {descriptor.Name}");
+
+        var parameters = descriptorMethod.GetParameters();
+
+        if (!parameters.Any())
+        {
+            if (parameterlessMethods.Contains(descriptorMethod))
+                continue;
+
+            throw new Exception($"No parameter for method {descriptorMethod.Name} on {descriptor.Name}");
+        }
+
+        if (parameters.Length > 1)
+            throw new Exception($"More than one parameter for method {descriptorMethod.Name} on {descriptor.Name}");
+
+        if (parameters[0].ParameterType != typeof(bool?))
+            breakingDescriptors.Add($"{descriptor.FullName} method {descriptorMethod.Name} does not take nullable bool");
+
+        if (!parameters[0].HasDefaultValue)
+        {
+            if (nonDefaultValueMethods.Contains(descriptorMethod))
+                continue;
+
+            breakingDescriptors.Add($"{descriptor.FullName} method {descriptorMethod.Name} does not have a default value");
+        }
+    }
+}
+
+breakingDescriptors.Should().BeEmpty();
+----
+

docs/query-dsl/full-text/query-string/query-string-usage.asciidoc

@@ -32,7 +32,7 @@ q
     .FuzzyMaxExpansions(3)
     .FuzzyRewrite(RewriteMultiTerm.ConstantScore)
     .Rewrite(RewriteMultiTerm.ConstantScore)
-    .Fuziness(Fuzziness.Auto)
+    .Fuzziness(Fuzziness.Auto)
     .TieBreaker(1.2)
     .AnalyzeWildcard()
     .MinimumShouldMatch(2)
@@ -95,7 +95,7 @@ new QueryStringQuery
     "lowercase_expanded_terms": true,
     "enable_position_increments": true,
     "fuzzy_max_expansions": 3,
-    "fuziness": "AUTO",
+    "fuzziness": "AUTO",
     "fuzzy_prefix_length": 2,
     "analyze_wildcard": true,
     "auto_generate_phrase_queries": true,