add comment

iLexN · Oct 29, 2019 · 7ead243 · 7ead243
1 parent 48d6a0d
commit 7ead243
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/hkid.go b/hkid.go
@@ -1,5 +1,6 @@
 package hkid
 
+// Check HKID Format eg. CA182361(1).
 func CheckString(string string) *result {
 	hkid, e := validatePatten(string)
 	//if errors.Is(e, newPatterNotMatchError()) {
@@ -14,6 +15,10 @@ func CheckString(string string) *result {
 	return newHkidResultWithValid(hkid, false)
 }
 
+// Check HKID Format eg. CA182361(1).
+// part1 = "CA"
+// part2 = "182361"
+// part3 = "1"
 func CheckPart(part1 string, part2 string, part3 string) *result {
 	hkid := newHkid(part1, part2, part3)
 	return CheckString(hkid.Format())