Skip to content

Commit 683f007

Browse files
authored
Clarify return value for HttpHeaders#Remove(String) (dotnet#7402)
1 parent cb70f6c commit 683f007

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

xml/System.Net.Http.Headers/HttpHeaders.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,9 @@ New line characters in header values must be followed by a white-space character
414414
<Docs>
415415
<param name="name">The name of the header to remove from the collection.</param>
416416
<summary>Removes the specified header from the <see cref="T:System.Net.Http.Headers.HttpHeaders" /> collection.</summary>
417-
<returns>Returns <see cref="T:System.Boolean" />.</returns>
417+
<returns>
418+
<see langword="true" /> if <paramref name="name" /> is successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> was not found in the <see cref="T:System.Net.Http.Headers.HttpHeaders" /> collection or if <paramref name="item" /> is <see langword="null" />.
419+
</returns>
418420
<remarks>To be added.</remarks>
419421
</Docs>
420422
</Member>

0 commit comments

Comments
 (0)