Update docs on infinite data in shrinkers #676
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/TestData.fsx
Outdated
|
|
||
| When writing custom shrinkers, keep in mind that: | ||
|
|
||
| - The sequence of shrinks generated by the built-in shrinkers may be infinite. |
There was a problem hiding this comment.
This is not accurate. The built-in shrinkers all terminate for all inputs. If they do not, it's a bug.
Shrinking may take a long time though, but typically in pathological, constructed cases (such as a test that only fails for a particularly long input and for nothing else, and so all shrinks are tried without success)
A common problem with writing custom shrinkers is that they fail to terminate, typically because a shrinker returns a value that was already tried. A shrink function must take care never to return values that are larger or equal to its input.
docs/TestData.fsx
Outdated
| When writing custom shrinkers, keep in mind that: | ||
|
|
||
| - The sequence of shrinks generated by the built-in shrinkers may be infinite. | ||
| - Your custom shrinker function may be called even if no tests fail, so if your tests start stalling remember to also check your shrinker for infinite loops |
There was a problem hiding this comment.
see my comment on this on the corresponding issue for clarification
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#675