Skip to content

Commit 3b10358

Browse files
Mpdreamzgmarz
Mpdreamz
authored and
gmarz
committed
Fix/xmldocs netcore (#2587)
* add xmlDocs:true to relevant dotnet core projects * fix #2564 netstandard will now ship with xmldocs as well, fixed several xmldocs related warnings
1 parent 8bcf9d7 commit 3b10358

File tree

33 files changed

+227
-124
lines changed

33 files changed

+227
-124
lines changed

‎build/Elasticsearch.Net.nuspec‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,6 @@
4343
<file src="output\netstandard1.3\Elasticsearch.Net\Elasticsearch.Net.dll" target="lib\netstandard1.3"/>
4444
<file src="output\netstandard1.3\Elasticsearch.Net\Elasticsearch.Net.pdb" target="lib\netstandard1.3"/>
4545
<file src="output\netstandard1.3\Elasticsearch.Net\Elasticsearch.Net.pdb.srcsrv" target="lib\netstandard1.3"/>
46+
<file src="output\netstandard1.3\Elasticsearch.Net\Elasticsearch.Net.xml" target="lib\netstandard1.3"/>
4647
</files>
4748
</package>

‎build/NEST.nuspec‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,6 @@
4848
<file src="output\netstandard1.3\Nest\Nest.dll" target="lib\netstandard1.3"/>
4949
<file src="output\netstandard1.3\Nest\Nest.pdb" target="lib\netstandard1.3"/>
5050
<file src="output\netstandard1.3\Nest\Nest.pdb.srcsrv" target="lib\netstandard1.3"/>
51+
<file src="output\netstandard1.3\Nest\Nest.xml" target="lib\netstandard1.3"/>
5152
</files>
5253
</package>

‎docs/aggregations/bucket/geo-distance/geo-distance-aggregation-usage.asciidoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ new SearchRequest<Project>
4343
{
4444
Field = Field((Project p) => p.Location),
4545
Origin = "52.376, 4.894",
46-
Ranges = new List<Nest.Range>
46+
Ranges = new List<AggregationRange>
4747
{
48-
new Nest.Range { To = 100 },
49-
new Nest.Range { From = 100, To = 300 },
50-
new Nest.Range { From = 300 }
48+
new AggregationRange { To = 100 },
49+
new AggregationRange { From = 100, To = 300 },
50+
new AggregationRange { From = 300 }
5151
}
5252
}
5353
}

‎docs/aggregations/bucket/range/range-aggregation-usage.asciidoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ new SearchRequest<Project>
4141
Aggregations = new RangeAggregation("commit_ranges")
4242
{
4343
Field = Field<Project>(p => p.NumberOfCommits),
44-
Ranges = new List<Nest.Range>
44+
Ranges = new List<AggregationRange>
4545
{
46-
{ new Nest.Range { To = 100 } },
47-
{ new Nest.Range { From = 100, To = 500 } },
48-
{ new Nest.Range { From = 500 } }
46+
{ new AggregationRange { To = 100 } },
47+
{ new AggregationRange { From = 100, To = 500 } },
48+
{ new AggregationRange { From = 500 } }
4949
}
5050
}
5151
}

‎docs/aggregations/bucket/terms/terms-aggregation-usage.asciidoc‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,9 @@ states.Meta["foo"].Should().Be("bar");
132132
s => s
133133
.Size(0)
134134
.Aggregations(a => a
135-
.Terms("commits", st => st
135+
.Terms<int>("commits", st => st
136136
.Field(p => p.NumberOfCommits)
137+
.Missing(-1)
137138
)
138139
)
139140
----
@@ -145,9 +146,10 @@ s => s
145146
new SearchRequest<Project>
146147
{
147148
Size = 0,
148-
Aggregations = new TermsAggregation("commits")
149+
Aggregations = new TermsAggregation<int>("commits")
149150
{
150151
Field = Infer.Field<Project>(p => p.NumberOfCommits),
152+
Missing = -1
151153
}
152154
}
153155
----
@@ -160,7 +162,8 @@ new SearchRequest<Project>
160162
"aggs": {
161163
"commits": {
162164
"terms": {
163-
"field": "numberOfCommits"
165+
"field": "numberOfCommits",
166+
"missing": -1
164167
}
165168
}
166169
}

‎docs/common-options/time-unit/time-units.asciidoc‎

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,20 @@ twoDays.Should().BeLessThan(twoWeeks);
134134
(twoDays <= new Time("2d")).Should().BeTrue();
135135
----
136136

137+
Special Time values `0` and `-1` can be compared against eachother
138+
and other Time values although admittingly this is a tad nonsensical.
139+
140+
[source,csharp]
141+
----
142+
Time.MinusOne.Should().BeLessThan(Time.Zero);
143+
144+
Time.Zero.Should().BeGreaterThan(Time.MinusOne);
145+
146+
Time.Zero.Should().BeLessThan(twoDays);
147+
148+
Time.MinusOne.Should().BeLessThan(twoDays);
149+
----
150+
137151
And assert equality
138152

139153
[source,csharp]
@@ -146,9 +160,73 @@ twoDays.Should().Be(new Time("2d"));
146160
147161
(new Time("2.1d") == new Time(TimeSpan.FromDays(2.1))).Should().BeTrue();
148162
149-
(new Time("1") == new Time(1)).Should().BeTrue();
163+
(new Time("-1") == new Time(-1)).Should().BeFalse();
164+
165+
(new Time("-1") == Time.MinusOne).Should().BeTrue();
166+
----
167+
168+
[source,csharp]
169+
----
170+
private class StringParsingTestCases : List<Tuple<string, TimeSpan, string>>
171+
{
172+
public void Add(string original, TimeSpan expect, string toString) =>
173+
this.Add(Tuple.Create(original, expect, toString));
174+
175+
public void Add(string bad, string argumentExceptionContains) =>
176+
this.Add(Tuple.Create(bad, TimeSpan.FromDays(1), argumentExceptionContains));
177+
}
178+
----
179+
180+
[source,csharp]
181+
----
182+
var testCases = new StringParsingTestCases
183+
{
184+
{ "1000 nanos", new TimeSpan(10) , "1000nanos"},
185+
{ "1000nanos", new TimeSpan(10), "1000nanos"},
186+
{ "1000 NANOS", new TimeSpan(10), "1000nanos" },
187+
{ "1000NANOS", new TimeSpan(10), "1000nanos" },
188+
{ "10micros", new TimeSpan(100), "10micros" },
189+
{ "10 MS", new TimeSpan(0, 0, 0, 0, 10), "10ms" },
190+
{ "10ms", new TimeSpan(0, 0, 0, 0, 10), "10ms" },
191+
{ "10 ms", new TimeSpan(0, 0, 0, 0, 10), "10ms" },
192+
{ "10s", new TimeSpan(0, 0, 10), "10s" },
193+
{ "-10s", new TimeSpan(0, 0, -10), "-10s" },
194+
{ "-10S", new TimeSpan(0, 0, -10), "-10s" },
195+
{ "10m", new TimeSpan(0, 10, 0) , "10m"},
196+
{ "10M", new TimeSpan(300, 0, 0, 0), "10M" }, // 300 days not minutes
197+
{ "10h", new TimeSpan(10, 0, 0), "10h" },
198+
{ "10H", new TimeSpan(10, 0, 0) , "10h"},
199+
{ "10d", new TimeSpan(10, 0, 0, 0) , "10d"},
200+
};
201+
----
202+
203+
[source,csharp]
204+
----
205+
foreach (var testCase in testCases)
206+
{
207+
var time = new Time(testCase.Item1);
208+
time.ToTimeSpan().Should().Be(testCase.Item2, "we passed in {0}", testCase.Item1);
209+
time.ToString().Should().Be(testCase.Item3);
210+
}
211+
----
212+
213+
[source,csharp]
214+
----
215+
var testCases = new StringParsingTestCases
216+
{
217+
{ "1000", "missing an interval"},
218+
{ "1000x", "string is invalid"},
219+
};
220+
----
150221

151-
(new Time("-1") == new Time(-1)).Should().BeTrue();
222+
[source,csharp]
223+
----
224+
foreach (var testCase in testCases)
225+
{
226+
Action create = () => new Time(testCase.Item1);
227+
var e = create.Invoking((a) => a()).ShouldThrow<ArgumentException>(testCase.Item1).Subject.First();
228+
e.Message.Should().Contain(testCase.Item3);
229+
}
152230
----
153231

154232
=== Units of Time

‎docs/mapping/scalar/scalar-usage.asciidoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ public class ScalarPoco
103103
public IEnumerable<string> Strings { get; set; }
104104
105105
public ScalarEnum Enum { get; set; }
106+
107+
public DateRange DateRange { get; set; }
108+
public DoubleRange DoubleRange { get; set; }
109+
public IntegerRange IntegerRange { get; set; }
110+
public FloatRange FloatRange { get; set; }
111+
public LongRange LongRange { get; set; }
106112
}
107113
----
108114

@@ -179,6 +185,11 @@ f => f
179185
.Scalar(p => p.String, m => m)
180186
.Scalar(p => p.Strings, m => m)
181187
.Scalar(p => p.Enum, m => m)
188+
.Scalar(p => p.DateRange, m => m)
189+
.Scalar(p => p.IntegerRange, m => m)
190+
.Scalar(p => p.FloatRange, m => m)
191+
.Scalar(p => p.LongRange, m => m)
192+
.Scalar(p => p.DoubleRange, m => m)
182193
)
183194
----
184195

@@ -394,6 +405,21 @@ null
394405
},
395406
"enum": {
396407
"type": "integer"
408+
},
409+
"dateRange": {
410+
"type": "date_range"
411+
},
412+
"integerRange": {
413+
"type": "integer_range"
414+
},
415+
"doubleRange": {
416+
"type": "double_range"
417+
},
418+
"longRange": {
419+
"type": "long_range"
420+
},
421+
"floatRange": {
422+
"type": "float_range"
397423
}
398424
}
399425
}

‎docs/query-dsl/term-level/range/numeric-range-query-usage.asciidoc‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ q
2828
.GreaterThanOrEquals(1.1)
2929
.LessThan(2.1)
3030
.LessThanOrEquals(2.0)
31+
.Relation(RangeRelation.Within)
3132
)
3233
----
3334

@@ -43,7 +44,8 @@ new NumericRangeQuery
4344
GreaterThan = 1.0,
4445
GreaterThanOrEqualTo = 1.1,
4546
LessThan = 2.1,
46-
LessThanOrEqualTo = 2.0
47+
LessThanOrEqualTo = 2.0,
48+
Relation = RangeRelation.Within
4749
}
4850
----
4951

@@ -58,7 +60,8 @@ new NumericRangeQuery
5860
"gt": 1.0,
5961
"gte": 1.1,
6062
"lt": 2.1,
61-
"lte": 2.0
63+
"lte": 2.0,
64+
"relation": "within"
6265
}
6366
}
6467
}

‎src/Elasticsearch.Net/project.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@
2929
},
3030
"copyright": "2014-2016 Elasticsearch BV",
3131
"buildOptions": {
32-
"warningsAsErrors": false
32+
"warningsAsErrors": false,
33+
"xmlDocs":true,
34+
"nowarn": ["CS1591", "1591", "1573"]
3335
},
3436
"configurations": {
3537
"Debug": {

‎src/Nest/Analysis/Analyzers/LanguageAnalyzer.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ public override string Type
4444
/// <inheritdoc/>
4545
public IEnumerable<string> StemExclusionList { get; set; }
4646

47-
[JsonIgnore]
4847
/// <inheritdoc/>
48+
[JsonIgnore]
4949
public Language? Language {
5050
get { return _type.ToEnum<Language>(); }
5151
set { _type = value.GetStringValue().ToLowerInvariant(); }

0 commit comments

Comments
 (0)