go/validate
3
0
Fork 0
Code Issues 2 Pull Requests Actions Activity

fix incorrect and vague doc comments

Browse Source 
Audit ahead of the README/doc.go work (issue #3):

- number.go: Min, MinFloat32, MinFloat64 all said "less than or equal to a
  given maximum" -- copy-pasted from the Max family. They check the
  minimum. Fixed.
- chars_test.go: ExampleExceptChars called Chars, not ExceptChars, so it
  never exercised the function it documents.
- chars.go: "does not contain disallowed characters" was circular.
- in.go: NotIn's parameter was named "allow"; renamed to "disallow".
- length.go: note that length is bytes (len), not runes -- the "%d
  characters" messages imply otherwise.
- url.go: spell out that ParseRequestURI wants an absolute URL or path.
- uuid.go: note lowercase-hex only, version/variant not checked.
- error.go: explain Err (the match-anything sentinel), how Error() formats
  with Data, and what With does. all.go: point at Collect.

Comments only; no behaviour change. go vet + go test ./... pass.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
claude
2026-09-07 13:59:59 +01:00
co-authored by Claude Sonnet 5
parent 7ea26f9c88
commit da971f4df5
9 changed files with 38 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
number.go
+9 -9
View File
@@ -8,7 +8,7 @@ var (
)
// Max validates whether an integer is less than or equal to a given maximum.
// If exclusive is true, an equal value will also produce an error.
// If exclusive is true, an equal value also produces an error.
func Max(n int, exclusive bool) func(int) error {
return func(value int) error {
if exclusive {
@@ -24,7 +24,7 @@ func Max(n int, exclusive bool) func(int) error {
}
// MaxFloat32 validates whether a float32 is less than or equal to a given maximum.
// If exclusive is true, an equal value will also produce an error.
// If exclusive is true, an equal value also produces an error.
func MaxFloat32(n float32, exclusive bool) func(float32) error {
return func(value float32) error {
if exclusive {
@@ -40,7 +40,7 @@ func MaxFloat32(n float32, exclusive bool) func(float32) error {
}
// MaxFloat64 validates whether a float64 is less than or equal to a given maximum.
// If exclusive is true, an equal value will also produce an error.
// If exclusive is true, an equal value also produces an error.
func MaxFloat64(n float64, exclusive bool) func(float64) error {
return func(value float64) error {
if exclusive {
@@ -55,8 +55,8 @@ func MaxFloat64(n float64, exclusive bool) func(float64) error {
}
}
// Min validates whether an integer is less than or equal to a given maximum.
// If exclusive is true, an equal value will also produce an error.
// Min validates whether an integer is greater than or equal to a given minimum.
// If exclusive is true, an equal value also produces an error.
func Min(n int, exclusive bool) func(int) error {
return func(value int) error {
if exclusive {
@@ -71,8 +71,8 @@ func Min(n int, exclusive bool) func(int) error {
}
}
// MinFloat32 validates whether a float32 is less than or equal to a given maximum.
// If exclusive is true, an equal value will also produce an error.
// MinFloat32 validates whether a float32 is greater than or equal to a given minimum.
// If exclusive is true, an equal value also produces an error.
func MinFloat32(n float32, exclusive bool) func(float32) error {
return func(value float32) error {
if exclusive {
@@ -87,8 +87,8 @@ func MinFloat32(n float32, exclusive bool) func(float32) error {
}
}
// MinFloat64 validates whether a float64 is less than or equal to a given maximum.
// If exclusive is true, an equal value will also produce an error.
// MinFloat64 validates whether a float64 is greater than or equal to a given minimum.
// If exclusive is true, an equal value also produces an error.
func MinFloat64(n float64, exclusive bool) func(float64) error {
return func(value float64) error {
if exclusive {