Skip to content

Commit 7d3044b

Browse files
committed
Add search usage to docs
Visit foreach statements when generating source code documentation Add ability to hide code with preceding //hide comment Tidy up existing docs
1 parent 30166f6 commit 7d3044b

File tree

71 files changed

+1007
-745
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+1007
-745
lines changed

docs/asciidoc/aggregations/bucket/date-histogram/date-histogram-aggregation-usage.asciidoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,17 @@ var dateHistogram = response.Aggs.DateHistogram("projects_started_per_month");
129129
dateHistogram.Should().NotBeNull();
130130
dateHistogram.Buckets.Should().NotBeNull();
131131
dateHistogram.Buckets.Count.Should().BeGreaterThan(10);
132-
item.Date.Should().NotBe(default(DateTime));
133-
item.DocCount.Should().BeGreaterThan(0);
134-
var nested = item.Nested("project_tags");
135-
nested.Should().NotBeNull();
136-
var nestedTerms = nested.Terms("tags");
137-
nestedTerms.Buckets.Count.Should().BeGreaterThan(0);
132+
133+
foreach (var item in dateHistogram.Buckets)
134+
{
135+
item.Date.Should().NotBe(default(DateTime));
136+
item.DocCount.Should().BeGreaterThan(0);
137+
138+
var nested = item.Nested("project_tags");
139+
nested.Should().NotBeNull();
140+
141+
var nestedTerms = nested.Terms("tags");
142+
nestedTerms.Buckets.Count.Should().BeGreaterThan(0);
143+
}
138144
----
139145

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,13 @@ dateHistogram.Buckets.Should().NotBeNull();
105105

106106
We specified three ranges so we expect to have three of them in the response
107107

108-
=== Handling Responses
109-
110108
[source,csharp]
111109
----
112110
dateHistogram.Buckets.Count.Should().Be(3);
113111
114-
item.DocCount.Should().BeGreaterThan(0);
112+
foreach (var item in dateHistogram.Buckets)
113+
{
114+
item.DocCount.Should().BeGreaterThan(0);
115+
}
115116
----
116117

docs/asciidoc/aggregations/bucket/filters/filters-aggregation-usage.asciidoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,12 @@ var filterAgg = response.Aggs.Filters("projects_by_state");
235235
filterAgg.Should().NotBeNull();
236236
var results = filterAgg.AnonymousBuckets();
237237
results.Count.Should().Be(4);
238-
singleBucket.DocCount.Should().BeGreaterThan(0);
238+
239+
foreach (var singleBucket in results.Take(3))
240+
{
241+
singleBucket.DocCount.Should().BeGreaterThan(0);
242+
}
243+
239244
results.Last().DocCount.Should().Be(0); <1>
240245
----
241246
<1> The last bucket is the _other bucket_

docs/asciidoc/aggregations/bucket/histogram/histogram-aggregation-usage.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ new SearchRequest<Project>
6464
response.IsValid.Should().BeTrue();
6565
var commits = response.Aggs.Histogram("commits");
6666
commits.Should().NotBeNull();
67-
item.DocCount.Should().BeGreaterThan(0);
67+
68+
foreach (var item in commits.Buckets)
69+
item.DocCount.Should().BeGreaterThan(0);
6870
----
6971

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ var ipRanges = response.Aggs.IpRange("ip_ranges");
7272
ipRanges.Should().NotBeNull();
7373
ipRanges.Buckets.Should().NotBeNull();
7474
ipRanges.Buckets.Count.Should().BeGreaterThan(0);
75-
range.DocCount.Should().BeGreaterThan(0);
75+
76+
foreach (var range in ipRanges.Buckets)
77+
range.DocCount.Should().BeGreaterThan(0);
7678
----
7779

docs/asciidoc/aggregations/bucket/nested/nested-aggregation-usage.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,11 @@ var tags = response.Aggs.Nested("tags");
7171
tags.Should().NotBeNull();
7272
var tagNames = tags.Terms("tag_names");
7373
tagNames.Should().NotBeNull();
74-
item.Key.Should().NotBeNullOrEmpty();
75-
item.DocCount.Should().BeGreaterThan(0);
74+
75+
foreach(var item in tagNames.Buckets)
76+
{
77+
item.Key.Should().NotBeNullOrEmpty();
78+
item.DocCount.Should().BeGreaterThan(0);
79+
}
7680
----
7781

docs/asciidoc/aggregations/bucket/reverse-nested/reverse-nested-aggregation-usage.asciidoc

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,13 +99,20 @@ var tags = response.Aggs.Nested("tags");
9999
tags.Should().NotBeNull();
100100
var tagNames = tags.Terms("tag_names");
101101
tagNames.Should().NotBeNull();
102-
tagName.Key.Should().NotBeNullOrEmpty();
103-
tagName.DocCount.Should().BeGreaterThan(0);
104-
var tagsToProjects = tagName.ReverseNested("tags_to_project");
105-
tagsToProjects.Should().NotBeNull();
106-
var topProjectsPerTag = tagsToProjects.Terms("top_projects_per_tag");
107-
topProjectsPerTag.Should().NotBeNull();
108-
topProject.Key.Should().NotBeNullOrEmpty();
109-
topProject.DocCount.Should().BeGreaterThan(0);
102+
103+
foreach(var tagName in tagNames.Buckets)
104+
{
105+
tagName.Key.Should().NotBeNullOrEmpty();
106+
tagName.DocCount.Should().BeGreaterThan(0);
107+
var tagsToProjects = tagName.ReverseNested("tags_to_project");
108+
tagsToProjects.Should().NotBeNull();
109+
var topProjectsPerTag = tagsToProjects.Terms("top_projects_per_tag");
110+
topProjectsPerTag.Should().NotBeNull();
111+
foreach(var topProject in topProjectsPerTag.Buckets)
112+
{
113+
topProject.Key.Should().NotBeNullOrEmpty();
114+
topProject.DocCount.Should().BeGreaterThan(0);
115+
}
116+
}
110117
----
111118

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,13 @@ var states = response.Aggs.Terms("states");
103103
states.Should().NotBeNull();
104104
states.DocCountErrorUpperBound.Should().HaveValue();
105105
states.SumOtherDocCount.Should().HaveValue();
106-
item.Key.Should().NotBeNullOrEmpty();
107-
item.DocCount.Should().BeGreaterOrEqualTo(1);
106+
107+
foreach (var item in states.Buckets)
108+
{
109+
item.Key.Should().NotBeNullOrEmpty();
110+
item.DocCount.Should().BeGreaterOrEqualTo(1);
111+
}
112+
108113
states.Meta.Should().NotBeNull().And.HaveCount(1);
109114
states.Meta["foo"].Should().Be("bar");
110115
----

docs/asciidoc/aggregations/metric/percentile-ranks/percentile-ranks-aggregation-usage.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ response.IsValid.Should().BeTrue();
7979
var commitsOutlier = response.Aggs.PercentileRanks("commits_outlier");
8080
commitsOutlier.Should().NotBeNull();
8181
commitsOutlier.Items.Should().NotBeNullOrEmpty();
82-
item.Should().NotBeNull();
82+
83+
foreach (var item in commitsOutlier.Items)
84+
item.Should().NotBeNull();
8385
----
8486

docs/asciidoc/aggregations/metric/percentiles/percentiles-aggregation-usage.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ response.IsValid.Should().BeTrue();
8080
var commitsOutlier = response.Aggs.Percentiles("commits_outlier");
8181
commitsOutlier.Should().NotBeNull();
8282
commitsOutlier.Items.Should().NotBeNullOrEmpty();
83-
item.Value.Should().BeGreaterThan(0);
83+
84+
foreach (var item in commitsOutlier.Items)
85+
item.Value.Should().BeGreaterThan(0);
8486
----
8587

0 commit comments

Comments
 (0)