Clarify Guid.Variant property documentation #12186
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
needs-area-label
jkotas
changed the title
Co-authored-by: jkotas <[email protected]>
Co-authored-by: jkotas <[email protected]>
Copilot
AI
changed the title
[WIP] Port changes from runtime/pull/118987 to dotnet-api-docs
Port runtime commit f05f25b2: Clarify Guid.Variant property documentation
Jan 1, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR ports documentation improvements from dotnet/runtime that clarify the Guid.Variant property documentation. The changes make it easier for developers to understand what the property returns and how different UUID versions use the variant field.
Key Changes:
- Replaced technical bit-level description with clearer explanation that the property returns all 4 bits unmasked
- Added a concrete UUIDv7 example to illustrate "don't-care" bits
- Updated wording to align with dotnet-api-docs style guide
Member
|
@tannergooding @nohwnd Porting changes from dotnet/runtime#118987 to official docs. Note that the copilot made a minor style change. |
tannergooding
approved these changes
Jan 1, 2026
jkotas
changed the title
gewarren
approved these changes
Jan 1, 2026
Contributor
gewarren
left a comment
gewarren
left a comment
There was a problem hiding this comment.
Left some suggestions for consideration.
Comment on lines
+3143
to
+3144
| <para>This property returns all 4 bits as is. Some users might only care about fewer bits of the variant field and should refer to <see href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</see> for how to interpret the result.</para> | ||
| <para>For example, UUIDv7 might only want to consider the 2 most significant bits of the field, as the least 2 significant bits are documented as "don't-care".</para> |
Contributor
There was a problem hiding this comment.
Suggested change
| <para>This property returns all 4 bits as is. Some users might only care about fewer bits of the variant field and should refer to <see href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</see> for how to interpret the result.</para> | |
| <para>For example, UUIDv7 might only want to consider the 2 most significant bits of the field, as the least 2 significant bits are documented as "don't-care".</para> | |
| <para>This property returns all 4 bits as-is. If you only care about fewer bits of the variant field, see <see href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</see> for information on how to interpret the result.</para> | |
| <para>For example, [the UUIDv7 standard](https://uuidv7.org/) might only want to consider the two most significant bits of the field, as the least two significant bits are documented as "don't-care".</para> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Ports documentation improvements from dotnet/runtime@f05f25b2 that clarify how to interpret the
Guid.Variantproperty value.