Document Base64Url character encoding details in API reference #11470
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the documentation for the
System.Buffers.Text.Base64Url
class to clearly specify which characters are used in Base64Url encoding, addressing a documentation gap identified by users.Changes Made
Class-level documentation:
<remarks>
section to explain that Base64Url uses the same alphabet as standard Base64 encoding, except that the characters+
and/
are replaced with-
and_
respectively to make the output URL-safe.Method-level documentation:
<remarks>
section for all encoding methods (EncodeToString
,EncodeToChars
,EncodeToUtf8
, and their overloads) to mention the specific character replacements.Before
The documentation only mentioned "URL-safe ASCII encoded text" and "Base64Url characters" without specifying what makes it URL-safe or what the actual character set differences are.
After
The documentation now clearly explains:
+
and/
characters (namely-
and_
)This change helps developers understand the practical differences between standard Base64 and Base64Url encoding without having to reference external specifications.
Fixes #11469.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.