Skip to content

Commit 0c04648

Browse files
committed
Docs: Fix spelling errors in changelog
1 parent c66b04f commit 0c04648

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

CHANGELOG.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,15 @@
55

66
## Release 0.7.4 (2025-10-31) [diff](https://github.com/jockbert/monkey_test/compare/v0.7.3...v0.7.4)
77

8-
This release focuses on making the crate buildable again by pinning down
9-
version of dependency.
8+
This release makes the crate buildable again by pinning down version on dependency.
109

1110
### Other changes
1211

1312
* Pin down dependency `rand_chacha` to version 0.3.1 instead of the floating
1413
version 0. Version 0.9.0 of `rand_chacha` introduces API changes that
1514
currently breaks `monkey_test`.
16-
* Only expose some functions in test-configuration, in order to removing
17-
dead code warning.
15+
* Only expose some functions in test-configuration, in order to remove
16+
dead code warnings.
1817
* Eliminate some clippy warnings.
1918

2019
## Release 0.7.3 (2024-06-06) [diff](https://github.com/jockbert/monkey_test/compare/v0.7.2...v0.7.3)
@@ -27,7 +26,7 @@ This release focuses on adding filtering to generators and shrinkers.
2726
to generate any `u8` value besides zero. This can now be achieved by using
2827
generator `monkey_test::gen::u8::any()` and just filter out the value zero.
2928
The filtering is also propagated to the associated shinker too, so even if
30-
failure is found, the value zero will not be one of the shinked examples used
29+
failure is found, the value zero will not be one of the shrinked examples used
3130
when searching for a smaller failure.
3231
* If example filtering is too heavy in either generator or shrinker, the
3332
filtering will complain about it by throwing a panic with a hopefully
@@ -39,7 +38,7 @@ This release focuses on adding filtering to generators and shrinkers.
3938
equality. These panics should also be caught and treated as a property
4039
failure.
4140

42-
Previously, unexpectedly panicing in non-panic-related test, monkey_test
41+
Previously, unexpectedly panicking in non-panic-related test, monkey_test
4342
did not even say for which example it occurred, basicly just aborting
4443
the normal monkey_test procedure. This is now fixed and panics are
4544
caught and treated as any other failure in the monkey_test procedure.
@@ -51,15 +50,15 @@ This release focuses on adding valid-range-aware integer shrinkers.
5150
### New features
5251

5352
* Improve default integer shrinker, so it keeps track of the range of valid
54-
values and only provide skrinked candidates within that range. This is useful
53+
values and only provide shrunk candidates within that range. This is useful
5554
if integer generator is given an explicit range for the examples generated,
5655
then this range is also used in the shrinker, so in case of a failure also
57-
the shrinked candidates are kept witin this given range.
56+
the shrinked candidates are kept within this given range.
5857

5958
### Other changes
6059

61-
* Improve the main documentation with additional examples in the common classes
62-
of properties and add a table of contents.
60+
* Improve the main documentation with additional examples in the common types
61+
of property-based tests and add a table of contents.
6362

6463
## Release 0.7.1 (2024-04-13) [diff](https://github.com/jockbert/monkey_test/compare/v0.7.0...v0.7.1)
6564

@@ -115,7 +114,7 @@ informative panic messages when a property fails.
115114
* Use different seeds for the different parts of generated tuple in `gen::zip`.
116115
Earlier, same seed was used for the different parts of tuple
117116
generator (`zip`). This lead to tuples where both parts/items
118-
of tuple got the same value, if same generator type happended to be used
117+
of tuple got the same value, if same generator type happened to be used
119118
for both tuple parts/items, only generating symmetric tuples
120119
like `(42, 42)` and `(1337, 1337)`.
121120

@@ -168,19 +167,20 @@ Release with focus on improving vector generator and vector shrinker performance
168167
in order to increase the overall effectiveness of the vector shrinker.
169168
* Greatly improve integer shrinking speed.
170169
By first trying some candidates exponentially closer to target (zero),
171-
the integer shinker has the potential for greatly reduced shrinking
170+
the integer shrinker has the potential for greatly reduced shrinking
172171
effort, compared to old way. In the old way, candidates was tried consecutive
173172
in decrementing order from the original value, shrinking in linear time.
174173
* Include some overweight to the value zero (0) in integer generators, if zero
175174
is included in the range generated. This should increase the possibility to
176175
find property bugs related to boundary cases related to the value zero.
177-
As before, some overwheight is also given to the extremes (min and max) of
176+
As before, some overweight is also given to the extremes (min and max) of
178177
the integer range generated.
179178

180179
### Breaking changes
181180

182181
* Rename shrinker `shrink::number()` to `shrinker::int()`, in order to make
183-
the shrinker name more specific and distinct. The same applies to module `shrink::num_shrink` which is renamed to `shrink::integer`.
182+
the shrinker name more specific and distinct. The same applies to module
183+
`shrink::num_shrink` which is renamed to `shrink::integer`.
184184
This is a preparation step for in the future also adding
185185
shrinkers for types `f32` and `f64`, which are also numbers, but are types
186186
that will not be supported by the existing integer shrinker, hence the name
@@ -208,7 +208,7 @@ Release with focus on functional style generator composition with `zip` and
208208

209209
### New features
210210

211-
* Add possibility to zip genrators together, with `gen::zip`, into generators of
211+
* Add possibility to zip generators together, with `gen::zip`, into generators of
212212
tuples.
213213
* Add possibility to map generators from on type to another, with `gen::map`.
214214
Together with zipping, this can be used for creating generators and shrinkers
@@ -218,7 +218,7 @@ Release with focus on functional style generator composition with `zip` and
218218
values (minimum and maximum).
219219

220220
The value of this is that you have a completely random generator of
221-
all possible u64-type values, the chance of actualy testing the
221+
all possible u64-type values, the chance of actually testing the
222222
extreme values (in this case 0 and 2^64-1) is extremely small in the
223223
100 examples actually applied to a propery. Testing with the extreme
224224
values are important, if you want to find bugs.
@@ -232,7 +232,8 @@ Release with focus on functional style generator composition with `zip` and
232232
### Breaking changes
233233

234234
* Rename `ConfAndGen::check_true` to `ConfAndGen::test_property`. This naming
235-
should make more sense when adding assert methods to `MonkeyResult`, like `MonkeyResult::assert_minimum_failure`.
235+
should make more sense when adding assert methods to `MonkeyResult`, like
236+
`MonkeyResult::assert_minimum_failure`.
236237

237238
## Release 0.3.0 (2024-01-19) [diff](https://github.com/jockbert/monkey_test/compare/v0.2.0...v0.3.0)
238239

@@ -259,9 +260,9 @@ not a problem until shown otherwise.
259260
* Expose Box type aliases `BoxGen<E>` and `BoxShrink<E>` for `Gen<E>` and
260261
`Shrink<E>` in API.
261262
* Add generators to pick values among given set of values, with either even
262-
distribution or oter distribution of users choosing.
263+
distribution or other distribution of users choosing.
263264
* Add generators to mix together values from other generators, with either even
264-
distribution or oter distribution of users choosing.
265+
distribution or other distribution of users choosing.
265266
* Add success count to monkey test assert message.
266267

267268
### Breaking changes
@@ -296,7 +297,7 @@ not a problem until shown otherwise.
296297
* Configuration structs are (moved and) renamed from `Monkey` and
297298
`MonkeyWithGen` to `Conf` and `ConfWithGen`.
298299
* Type alias `SomeShrink<E> = Box<dyn Shrink<E>>` is replaced with use of
299-
generic arguments for shrinker on all places ursed.
300+
generic arguments for shrinker on all places used.
300301
* Rename `Gen.iter` to `Gen.examples`. This hopefully makes the purpose of
301302
the returned iterator more clear.
302303
* Include shinker in generator, adding method `Gen.shrinker`. This enables

0 commit comments

Comments
 (0)