[Uid] Expand the explanation about the different UUID variants #19710
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.
I'm always in favor of making docs as concise as possible, but I think that in this case we should do the opposite and expand the existing docs a bit.
First, the explanation of UUIDs is a very big block of code: https://symfony.com/doc/current/components/uid.html#generating-uuids It looks intimidating and not that clear.
Second, we don't mention many details about some UUIDs, so I propose to add more details.
Lastly, the current examples don't work for UUIDv3 and v5. The given namespace argument must be a
Uuid
object, not a string: