Skip to content

Commit c0c2286

Browse files
KPStolkMpdreamz
authored andcommitted
Updated Xmldocs (#3518)
* Updated Xmldocs Updated Xmldocs to clarify that exceptions are not thrown for bulk actions. * Updated ThrowExceptions XmlDocs to explicitly mark an exception for SuccessOrKnownError
1 parent 8388a95 commit c0c2286

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

src/Elasticsearch.Net/Configuration/ConnectionConfiguration.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ public T EnableTcpKeepAlive(TimeSpan keepAliveTime, TimeSpan keepAliveInterval)
279279
public T DisableAutomaticProxyDetection(bool disable = true) => Assign(a => a._disableAutomaticProxyDetection = disable);
280280

281281
/// <summary>
282-
/// Instead of following a c/go like error checking on response.IsValid always throw an exception
282+
/// Instead of following a c/go like error checking on response.IsValid do throw an exception (except when <see cref="IApiCallDetails.SuccessOrKnownError"/> is false)
283283
/// on the client when a call resulted in an exception on either the client or the Elasticsearch server.
284284
/// <para>Reasons for such exceptions could be search parser errors, index missing exceptions, etc...</para>
285285
/// </summary>

src/Elasticsearch.Net/Configuration/IConnectionConfigurationValues.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ public interface IConnectionConfigurationValues : IDisposable
206206
bool SniffsOnStartup { get; }
207207

208208
/// <summary>
209-
/// Instead of following a c/go like error checking on response.IsValid always throw an exception
209+
/// Instead of following a c/go like error checking on response.IsValid do throw an exception (except when <see cref="IApiCallDetails.SuccessOrKnownError"/> is false)
210210
/// on the client when a call resulted in an exception on either the client or the Elasticsearch server.
211211
/// <para>Reasons for such exceptions could be search parser errors, index missing exceptions, etc...</para>
212212
/// </summary>

src/Elasticsearch.Net/Configuration/RequestConfiguration.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public interface IRequestConfiguration
8888
string RunAs { get; set; }
8989

9090
/// <summary>
91-
/// Instead of following a c/go like error checking on response.IsValid always throw an exception
91+
/// Instead of following a c/go like error checking on response.IsValid do throw an exception (except when <see cref="IApiCallDetails.SuccessOrKnownError"/> is false)
9292
/// on the client when a call resulted in an exception on either the client or the Elasticsearch server.
9393
/// <para>Reasons for such exceptions could be search parser errors, index missing exceptions, etc...</para>
9494
/// </summary>

0 commit comments

Comments
 (0)