Complete uuids #28649
Merged
Complete uuids #28649
Conversation
This file contains 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
waldyrious
reviewed
Aug 14, 2018
base/uuid.jl
Outdated
| """ | ||
| Represents a Universally Unique Identifier (UUID). | ||
| Can be built from a UInt128 (all byte values), from two UInt64 or four UInt32. | ||
| Conversion from a string is will check the UUID validity. |
waldyrious
reviewed
Aug 14, 2018
base/uuid.jl
Outdated
| @@ -1,5 +1,10 @@ | |||
| # This file is a part of Julia. License is MIT: https://julialang.org/license | |||
|
|
|||
| """ | |||
| Represents a Universally Unique Identifier (UUID). | |||
| Can be built from a UInt128 (all byte values), from two UInt64 or four UInt32. | |||
There was a problem hiding this comment.
I'd suggest wrapping the types in backticks, and perhaps tweaking the phrasing to be more consistent when listing the three options -- e.g. "...from one UInt128 (all byte values), from two UInt64, or from four UInt32." (or only use "from" once). Note also the "a" --> "one", and the added comma after UInt64.
There was a problem hiding this comment.
I just re-read it, agreed on all points
StefanKarpinski
approved these changes
Aug 14, 2018
KristofferC
pushed a commit
that referenced
this pull request
Aug 19, 2018
* documented UUID type * fixed typo * improved sentence structure from doc (cherry picked from commit c62555b)
KristofferC
pushed a commit
that referenced
this pull request
Aug 19, 2018
* documented UUID type * fixed typo * improved sentence structure from doc (cherry picked from commit c62555b)
Merged
KristofferC
pushed a commit
that referenced
this pull request
Aug 19, 2018
* documented UUID type * fixed typo * improved sentence structure from doc (cherry picked from commit c62555b)
KristofferC
pushed a commit
that referenced
this pull request
Sep 8, 2018
* documented UUID type * fixed typo * improved sentence structure from doc (cherry picked from commit c62555b)
KristofferC
pushed a commit
that referenced
this pull request
Sep 8, 2018
* documented UUID type * fixed typo * improved sentence structure from doc (cherry picked from commit c62555b)
KristofferC
added
docs
KristofferC
pushed a commit
that referenced
this pull request
Feb 11, 2019
* documented UUID type * fixed typo * improved sentence structure from doc (cherry picked from commit c62555b)
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.
Add documentation to the UUID constructor in Base.
Also rewrote
uuid = uuid.valuetobytes = uuid.valuein the UUID package, it can be confusing to have the UUID struct with the same name as the internal bytes stored asUInt128.