Skip to content

Update HttpHeaders.Add exception docs #10493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Update HttpHeaders.Add exception docs #10493

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bae508
Update `HttpHeaders.Add` exception docs
MihaZupan Oct 3, 2024
3e2307d
Update HttpHeaders.xml
MihaZupan Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions xml/System.Net.Http.Headers/HttpHeaders.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@
<format type="text/markdown"><![CDATA[

## Remarks
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.

The header `values` will be parsed and validated.

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.
Expand All @@ -142,7 +144,7 @@

-or-

New line characters in header values must be followed by a white-space character.
The header value format is invalid for this header name, or the header does not support multiple values.
</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -187,7 +189,9 @@ New line characters in header values must be followed by a white-space character
<format type="text/markdown"><![CDATA[

## Remarks
The header `value` will be parsed and validated.
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.

The header `values` will be parsed and validated.

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.

Expand All @@ -201,7 +205,7 @@ New line characters in header values must be followed by a white-space character

-or-

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