small doc improvements

scrive · Jul 18, 2024 · cc05592 · cc05592
1 parent 28967a4
commit cc05592
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/PersonalNumber/Danish.elm b/src/PersonalNumber/Danish.elm
@@ -43,6 +43,8 @@ type PersonalNumber
     = PersonalNumber String
 
 
+{-| If the parsing fails an error of this type is returned.
+-}
 type ValidationError
     = InvalidLength
     | InvalidDate
@@ -137,7 +139,7 @@ display =
     toString
 
 
-{-| Males have odd and females have even individual number
+{-| Males have an odd serial number
 -}
 isMale : PersonalNumber -> Bool
 isMale (PersonalNumber str) =
@@ -152,6 +154,8 @@ isMale (PersonalNumber str) =
     modBy 2 serialPart == 1
 
 
+{-| Females have an even serial number
+-}
 isFemale : PersonalNumber -> Bool
 isFemale =
     not << isMale
diff --git a/src/PersonalNumber/Finnish.elm b/src/PersonalNumber/Finnish.elm
@@ -123,7 +123,7 @@ validateChecksum str =
         Err InvalidChecksum
 
 
-{-| Males have odd and females have even individual number
+{-| Males have an odd serial number
 -}
 isMale : PersonalNumber -> Bool
 isMale (PersonalNumber str) =
@@ -138,6 +138,8 @@ isMale (PersonalNumber str) =
     modBy 2 serialPart == 1
 
 
+{-| Females have an even serial number
+-}
 isFemale : PersonalNumber -> Bool
 isFemale =
     not << isMale