Skip to content

Commit f985b66

Browse files
authored
Update HttpHeaders.Add exception docs (#10493)
* Update `HttpHeaders.Add` exception docs * Update HttpHeaders.xml
1 parent 1ba74fe commit f985b66

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@
151151
<format type="text/markdown"><![CDATA[
152152
153153
## Remarks
154+
Header names are enforced to be valid HTTP tokens, where a token is defined as any set of ASCII letters, digits, or symbols from the ``"!#$%&'*+-.^_`|~"`` set, matching [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-collected-abnf)'s definition. Non-ASCII characters are not allowed in a header name.
155+
154156
The header `values` will be parsed and validated.
155157
156158
If the specified header does not exist, the <xref:System.Net.Http.Headers.HttpHeaders.Add%2A> method inserts a new header into the list of header name/value pairs.
@@ -166,7 +168,7 @@
166168

167169
-or-
168170

169-
New line characters in header values must be followed by a white-space character.
171+
The header value format is invalid for this header name, or the header does not support multiple values.
170172
</exception>
171173
</Docs>
172174
</Member>
@@ -220,7 +222,9 @@ New line characters in header values must be followed by a white-space character
220222
<format type="text/markdown"><![CDATA[
221223
222224
## Remarks
223-
The header `value` will be parsed and validated.
225+
Header names are enforced to be valid HTTP tokens, where a token is defined as any set of ASCII letters, digits, or symbols from the ``"!#$%&'*+-.^_`|~"`` set, matching [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-collected-abnf)'s definition. Non-ASCII characters are not allowed in a header name.
226+
227+
The header `values` will be parsed and validated.
224228
225229
If the specified header does not exist, the <xref:System.Net.Http.Headers.HttpHeaders.Add%2A> method inserts a new header into the list of header name/value pairs.
226230
@@ -234,7 +238,7 @@ New line characters in header values must be followed by a white-space character
234238

235239
-or-
236240

237-
New line characters in header values must be followed by a white-space character.
241+
The header value format is invalid for this header name, or the header does not support multiple values.
238242
</exception>
239243
</Docs>
240244
</Member>

0 commit comments

Comments
 (0)