Skip to content

Tweak grammar in godoc #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
untoldwind merged 1 commit into from
Apr 7, 2025
Merged

Tweak grammar in godoc #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions gen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ func (g Gen) WithLabel(label string) Gen {
//
// f(value) == true.
//
// Use this care, if the sieve to to fine the generator will have many misses which results
// in an undecided property.
// Use with care, if the sieve is too fine the generator will have many misses which
// results in an undecided property.
func (g Gen) SuchThat(f interface{}) Gen {
checkVal := reflect.ValueOf(f)
checkType := checkVal.Type()
Expand Down Expand Up @@ -101,7 +101,7 @@ func (g Gen) WithShrinker(shrinker Shrinker) Gen {
}
}

// Map creates a derived generator by mapping all generatored values with a given function.
// Map creates a derived generator by mapping all generated values with a given function.
// f: has to be a function with one parameter (matching the generated value) and a single return.
// Note: The derived generator will not have a sieve or shrinker unless you are mapping to the same type
// Note: The mapping function may have a second parameter "*GenParameters"
Expand Down Expand Up @@ -216,7 +216,7 @@ func (g Gen) MapResult(f func(*GenResult) *GenResult) Gen {
}
}

// CombineGens creates a generators from a list of generators.
// CombineGens creates a generator from a list of generators.
// The result type will be a []interface{} containing the generated values of each generators in
// the list.
// Note: The combined generator will not have a sieve or shrinker.
Expand Down