Documentation: Add notes to corner-case generators and fix some broken documentation references #336
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
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.
QCheck{,2.Gen}.small_int_cornersandQCheck{,2}.Gen.graft_cornershave internal state in the form of (a position in) the list of corner cases traversed. This can be a bit surprising so this PR adds a documentation note as a word of warning, incl. an example for the former.While running
dune build @docafterwards I noticed a bunch ofodoc-warnings, primarily about broken references, so the PR also contains a range of fixes to these.There are still warnings left - some about cross-packages references - and some about
Stdlibmodules.I've noticed the former are resolved in the documentation built and published on ocaml.org.