Skip to content

Commit

Permalink
Minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
danyx23 committed Jan 15, 2016
1 parent 0e82955 commit 34f4835
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
4 changes: 1 addition & 3 deletions src/Uuid.elm
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,7 @@ toString (Uuid internalString) =

{-| Create a Uuid from a String in the canonical form (e.g.
"63B9AAA2-6AAF-473E-B37E-22EB66E66B76"). Note that this module only supports
canonical Uuids, Versions 1-5 and will refuse to parse other Uuid variants
(i.e. only Uuids in the form xxxxxxxx-xxxx-4xxx-Yxxx-xxxxxxxxxxxx will be
successfully parsed)
canonical Uuids, Versions 1-5 and will refuse to parse other Uuid variants.
-}
fromString : String -> Maybe Uuid
fromString text =
Expand Down
7 changes: 2 additions & 5 deletions src/Uuid/Barebones.elm
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@ import Bitwise
import Random.PCG exposing (Generator, map, list, int, generate, Seed)

{-| Random.PCG Generator for Uuid Strings. Using this Generator instead of the generate
function let's you use the full power of the Random.PCG library to create lists of Uuids,
map them to other types
etc.
function lets you use the full power of the Random.PCG library to create lists of Uuids,
map them to other types etc.
-}
uuidStringGenerator : Generator String
uuidStringGenerator =
Expand All @@ -42,8 +41,6 @@ Uuid has 32 hex characters with 4 seperators. One of the characters
is fixed to 4 to indicate the version, and one is limited to the range
[8-B] (indicated with Y in the sample string):
xxxxxxxx-xxxx-4xxx-Yxxx-xxxxxxxxxxxx
Currently, the internal representation is the canonical string representation
but that might change in the future, e.g. to 4 32 bit values.
-}
toUuidString : List Int -> String
toUuidString thirtyOneHexDigits =
Expand Down

0 comments on commit 34f4835

Please sign in to comment.