Skip to content

Commit fb05345

Browse files
committed
Fix XML comments and documentation structure
This commit fixes XML comments, corrects file names and sets the correct section header level for generated documentation.
1 parent 84d77b6 commit fb05345

File tree

7 files changed

+8
-6
lines changed

7 files changed

+8
-6
lines changed

build/scripts/Commandline.fsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ NOTE: both the `test` and `integrate` targets can be suffixed with `-all` to for
4141
Execution hints can be provided anywhere on the command line
4242
- skiptests : skip running tests as part of the target chain
4343
- skipdocs : skip generating documentation
44+
- docs:<B> : the branch name B to use when generating documentation
4445
- seed:<N> : provide a seed to run the tests with.
4546
- random:<K><:B> : sets random K to bool B if if B is omitted will default to true
4647
K can be: sourceserializer, typedkeys or oldconnection (only valid on windows)

src/Nest/Search/Search/Collapsing/FieldCollapse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public FieldCollapseDescriptor<T> MaxConcurrentGroupSearches(int? maxConcurrentG
7070
/// <inheritdoc cref="IFieldCollapse.Field"/>
7171
public FieldCollapseDescriptor<T> Field(Expression<Func<T, object>> objectPath) => Assign(a => a.Field = objectPath);
7272

73-
/// <inheritdoc cref="IFieldCollapse.InnherHits"/>
73+
/// <inheritdoc cref="IFieldCollapse.InnerHits"/>
7474
public FieldCollapseDescriptor<T> InnerHits(Func<InnerHitsDescriptor<T>, IInnerHits> selector = null) =>
7575
Assign(a => a.InnerHits = selector.InvokeOrDefault(new InnerHitsDescriptor<T>()));
7676

src/Tests/Tests/Aggregations/Bucket/Composite/CompositeAggregationUsageTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ protected override void ExpectResponse(ISearchResponse<Project> response)
197197
}
198198

199199
/**[float]
200-
* == Missing buckets
200+
* === Missing buckets
201201
* By default documents without a value for a given source are ignored.
202202
* It is possible to include them in the response by setting missing_bucket to `true` (defaults to `false`):
203203
*

src/Tests/Tests/Aggregations/Bucket/DateHistogram/DateHistogramAggregationUsageTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ public DateHistogramAggregationUsageTests(ReadOnlyCluster i, EndpointUsage usage
112112

113113
protected override void ExpectResponse(ISearchResponse<Project> response)
114114
{
115-
/** === Handling responses
115+
/** ==== Handling responses
116116
* The `AggregateDictionary found on `.Aggregations` on `ISearchResponse<T>` has several helper methods
117117
* so we can fetch our aggregation results easily in the correct type.
118118
* <<handling-aggregate-response, Be sure to read more about these helper methods>>

src/Tests/Tests/Aggregations/Bucket/DateRange/DateRangeAggregationUsageTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public DateRangeAggregationUsageTests(ReadOnlyCluster i, EndpointUsage usage) :
7979

8080
protected override void ExpectResponse(ISearchResponse<Project> response)
8181
{
82-
/** === Handling Responses
82+
/** ==== Handling Responses
8383
* The `AggregateDictionary found on `.Aggregations` on `ISearchResponse<T>` has several helper methods
8484
* so we can fetch our aggregation results easily in the correct type.
8585
* <<handling-aggregate-response, Be sure to read more about these helper methods>>

src/Tests/Tests/Aggregations/Bucket/Filter/FilterAggregationUsageTests.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public FilterAggregationUsageTests(ReadOnlyCluster i, EndpointUsage usage) : bas
6262

6363
protected override void ExpectResponse(ISearchResponse<Project> response)
6464
{
65-
/** === Handling Responses
65+
/** ==== Handling Responses
6666
* The `AggregateDictionary found on `.Aggregations` on `ISearchResponse<T>` has several helper methods
6767
* so we can fetch our aggregation results easily in the correct type.
6868
* <<handling-aggregate-response, Be sure to read more about these helper methods>>
@@ -79,7 +79,7 @@ protected override void ExpectResponse(ISearchResponse<Project> response)
7979
}
8080

8181
/**[float]
82-
* == Empty Filter
82+
* === Empty Filter
8383
* When the collection of filters is empty or all are conditionless, NEST will serialize them
8484
* to an empty object.
8585
*/
@@ -124,6 +124,7 @@ protected override void ExpectResponse(ISearchResponse<Project> response)
124124
}
125125

126126
//reproduce of https://github.com/elastic/elasticsearch-net/issues/1931
127+
// hide
127128
public class InlineScriptFilterAggregationUsageTests : AggregationUsageTestBase
128129
{
129130
private string _ctxNumberofCommits = "doc['numberOfCommits'].value > 0";

0 commit comments

Comments
 (0)