Skip to content
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.

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

docs: upd links to rfc9562 #162

Merged
merged 4 commits into from
Jul 1, 2024
Merged

docs: upd links to rfc9562 #162

merged 4 commits into from
Jul 1, 2024

Conversation

alexbozhenko
Copy link
Contributor

@alexbozhenko alexbozhenko commented Jun 23, 2024

@alexbozhenko alexbozhenko requested a review from a team as a code owner June 23, 2024 22:22
@alexbozhenko
Copy link
Contributor Author

alos, could someone update the description of the github repo to include new rfc number?

@alexbozhenko alexbozhenko changed the title Upd links to rfc9562 docs: upd links to rfc9562 Jun 23, 2024
@alexbozhenko
Copy link
Contributor Author

@alexbozhenko
Copy link
Contributor Author

alexbozhenko commented Jun 23, 2024

And not sure if all other references to 4122 should be updated in this repo
https://sourcegraph.com/search?q=context:global+4122+repo:%5Egithub%5C.com/google/uuid%24+&patternType=keyword&sm=0

Copy link
Collaborator

@bormanp bormanp left a comment

Choose a reason for hiding this comment

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

Were there any changes of what was in the previous two documents? If so we may need to update the code.

@bormanp
Copy link
Collaborator

bormanp commented Jun 24, 2024

The constant RFC4122 cannot be changed though a new constant could be defined to be equal with it. Probably Standard = RFC4122 (or the other way around). Not sure it is worth it. There probably should be a note in the documentation that 9562 obsoletes 4122 so it makes sense why RFC4122 is the name of the standard variant.

I don't think the code comments need updating nor do the tests. For backwards compatibility I believe Variant.String will still need to return the string "RFC4122".

@bradleypeabody
Copy link

My suggestion would be along the lines of what @bormanp is saying - add another constant either Standard (or maybe just RFC) and/or RFC9562 with the same value as RFC4122 (i.e. probably just adding a separate const RFC = RFC4122 could be enough). And I would imagine that having Variant.String() return "RFC4122" is not really a deal breaker and that can be just left as-is until/unless there's a need to change it.

@alexbozhenko
Copy link
Contributor Author

alexbozhenko commented Jun 25, 2024

@bormanp @bradleypeabody thank you for your comments.
I added a new constant with the comment and had to change a couple of places in the comment to make it more consistent.
If you have suggestions how to improve wording, feel free to push to this branch(or use the code suggestion feature in the github review UI), so we can merge it and move on with our lives)

@alexbozhenko
Copy link
Contributor Author

@bormanp thank you for approving! Do you know who has the merge rights?

@bormanp bormanp merged commit d55c313 into google:master Jul 1, 2024
6 checks passed
tkarrass pushed a commit to tkarrass/uuid that referenced this pull request Sep 11, 2024
* upd links to draft

* RFC 4122 -> 9562

* add extra comment

---------

Co-authored-by: bormanp <[email protected]>
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.

3 participants