Skip to content

Commit 2965732

Browse files
gewarrengewarren
authored
standardize exception wording (dotnet#7631)
1 parent 39f0283 commit 2965732

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

‎xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml‎

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,8 @@
163163
<param name="value">The data to store in the cache.</param>
164164
<summary>Sets a sequence of bytes in the specified cache with the specified key.</summary>
165165
<remarks>To be added.</remarks>
166-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
166+
<exception cref="T:System.ArgumentNullException">
167+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
167168
</Docs>
168169
</Member>
169170
<Member MemberName="SetAsync">
@@ -194,7 +195,8 @@
194195
<summary>Asynchronously sets a sequence of bytes in the specified cache with the specified key.</summary>
195196
<returns>A task that represents the asynchronous set operation.</returns>
196197
<remarks>To be added.</remarks>
197-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
198+
<exception cref="T:System.ArgumentNullException">
199+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
198200
</Docs>
199201
</Member>
200202
<Member MemberName="SetAsync">
@@ -231,7 +233,8 @@
231233
<summary>Asynchronously sets a sequence of bytes in the specified cache with the specified key.</summary>
232234
<returns>A task that represents the asynchronous set operation.</returns>
233235
<remarks>To be added.</remarks>
234-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
236+
<exception cref="T:System.ArgumentNullException">
237+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
235238
</Docs>
236239
</Member>
237240
<Member MemberName="SetString">
@@ -268,7 +271,8 @@
268271
<param name="value">The data to store in the cache.</param>
269272
<summary>Sets a string in the specified cache with the specified key.</summary>
270273
<remarks>To be added.</remarks>
271-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
274+
<exception cref="T:System.ArgumentNullException">
275+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
272276
</Docs>
273277
</Member>
274278
<Member MemberName="SetString">
@@ -307,7 +311,8 @@
307311
<param name="options">The cache options for the entry.</param>
308312
<summary>Sets a string in the specified cache with the specified key.</summary>
309313
<remarks>To be added.</remarks>
310-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
314+
<exception cref="T:System.ArgumentNullException">
315+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
311316
</Docs>
312317
</Member>
313318
<Member MemberName="SetStringAsync">
@@ -338,7 +343,8 @@
338343
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
339344
<returns>A task that represents the asynchronous set operation.</returns>
340345
<remarks>To be added.</remarks>
341-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
346+
<exception cref="T:System.ArgumentNullException">
347+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
342348
</Docs>
343349
</Member>
344350
<Member MemberName="SetStringAsync">
@@ -371,7 +377,8 @@
371377
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
372378
<returns>A task that represents the asynchronous set operation.</returns>
373379
<remarks>To be added.</remarks>
374-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
380+
<exception cref="T:System.ArgumentNullException">
381+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
375382
</Docs>
376383
</Member>
377384
<Member MemberName="SetStringAsync">
@@ -408,7 +415,8 @@
408415
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
409416
<returns>A task that represents the asynchronous set operation.</returns>
410417
<remarks>To be added.</remarks>
411-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
418+
<exception cref="T:System.ArgumentNullException">
419+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
412420
</Docs>
413421
</Member>
414422
<Member MemberName="SetStringAsync">
@@ -447,7 +455,8 @@
447455
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
448456
<returns>A task that represents the asynchronous set operation.</returns>
449457
<remarks>To be added.</remarks>
450-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key" /> or <paramref name="value" /> is null.</exception>
458+
<exception cref="T:System.ArgumentNullException">
459+
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
451460
</Docs>
452461
</Member>
453462
</Members>

‎xml/Microsoft.Extensions.Configuration/UserSecretsConfigurationExtensions.xml‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@
6363
</summary>
6464
<returns>The configuration builder.</returns>
6565
<remarks>To be added.</remarks>
66-
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="assembly" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" /></exception>
66+
<exception cref="T:System.InvalidOperationException">
67+
<paramref name="assembly" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" /></exception>
6768
</Docs>
6869
</Member>
6970
<Member MemberName="AddUserSecrets">
@@ -147,7 +148,8 @@
147148
</summary>
148149
<returns>The configuration builder.</returns>
149150
<remarks>To be added.</remarks>
150-
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional" /> is false and <paramref name="assembly" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
151+
<exception cref="T:System.InvalidOperationException">
152+
<paramref name="optional" /> is false and <paramref name="assembly" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
151153
</Docs>
152154
</Member>
153155
<Member MemberName="AddUserSecrets">
@@ -229,7 +231,8 @@
229231
</summary>
230232
<returns>The configuration builder.</returns>
231233
<remarks>To be added.</remarks>
232-
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional" /> is false and <paramref name="assembly" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
234+
<exception cref="T:System.InvalidOperationException">
235+
<paramref name="optional" /> is false and <paramref name="assembly" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
233236
</Docs>
234237
</Member>
235238
<Member MemberName="AddUserSecrets&lt;T&gt;">
@@ -277,7 +280,7 @@
277280
</summary>
278281
<returns>The configuration builder.</returns>
279282
<remarks>To be added.</remarks>
280-
<exception cref="T:System.InvalidOperationException">Thrown when the assembly containing <typeparamref name="T" /> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
283+
<exception cref="T:System.InvalidOperationException">The assembly containing <typeparamref name="T" /> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
281284
</Docs>
282285
</Member>
283286
<Member MemberName="AddUserSecrets&lt;T&gt;">
@@ -327,7 +330,8 @@
327330
</summary>
328331
<returns>The configuration builder.</returns>
329332
<remarks>To be added.</remarks>
330-
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional" /> is false and the assembly containing <typeparamref name="T" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
333+
<exception cref="T:System.InvalidOperationException">
334+
<paramref name="optional" /> is false and the assembly containing <typeparamref name="T" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
331335
</Docs>
332336
</Member>
333337
<Member MemberName="AddUserSecrets&lt;T&gt;">
@@ -376,7 +380,8 @@
376380
</summary>
377381
<returns>The configuration builder.</returns>
378382
<remarks>To be added.</remarks>
379-
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional" /> is false and the assembly containing <typeparamref name="T" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
383+
<exception cref="T:System.InvalidOperationException">
384+
<paramref name="optional" /> is false and the assembly containing <typeparamref name="T" /> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</exception>
380385
</Docs>
381386
</Member>
382387
</Members>

0 commit comments

Comments
 (0)