Skip to content

docs: document byte order in parse() and stringify(). fixes #503#504

Merged
broofa merged 1 commit intomasterfrom
stringify_docs
Aug 3, 2020
Merged

docs: document byte order in parse() and stringify(). fixes #503#504
broofa merged 1 commit intomasterfrom
stringify_docs

Conversation

@broofa
Copy link
Copy Markdown
Member

@broofa broofa commented Aug 3, 2020

No description provided.

@broofa broofa requested a review from ctavan August 3, 2020 13:55
Copy link
Copy Markdown
Member

@ctavan ctavan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Should we mention though that this is the byte order recommended by the RFC but incompatible with they byte order produced by https://docs.microsoft.com/en-us/dotnet/api/system.guid ?

My suspicion is that if anybody runs into problems here, then .NET users where this is the default representation, so I think the note is mostly here to spare them some WTF-moments.

As a side note: Python offers both representations: https://docs.python.org/3/library/uuid.html UUID.bytes and UUID.bytes_le but from the naming it seems like they are treating big endian notation as the default as well.

@broofa
Copy link
Copy Markdown
Member Author

broofa commented Aug 3, 2020

Should we mention though that this is the byte order recommended by the RFC

Let's not. Between the note and the examples, it's clear what we're doing. I don't think we need to go into the "why" behind it.

@broofa broofa merged commit cfb3cdb into master Aug 3, 2020
@ctavan ctavan deleted the stringify_docs branch August 4, 2020 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants