Skip to content
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

Jump to bottom

Documentation polish #312

Merged
merged 10 commits into from
Jan 5, 2025
Merged

Documentation polish #312

merged 10 commits into from
Jan 5, 2025

Conversation

jmid
Copy link
Collaborator

@jmid jmid commented Jan 5, 2025

Fixes #309

This PR

  • adds documentation strings for QCheck{,2}.Gen.tup*
  • adds documentation strings for QCheck.Gen binding operators
  • adds a missing documentation string for QCheck.Print.unit
  • elaborates on the scarse QCheck.Shrink documentation
  • adds documentation strings for the QCheck.Iter module

While at it, the PR also

  • adds a warning about infinite shrinking loops and
  • collects the two qcheck and qcheck-core documentation front pages in doc/

@jmid jmid merged commit 835d02d into c-cube:main Jan 5, 2025
13 checks passed
@jmid jmid deleted the doc-polish branch January 5, 2025 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing QCheck documentation entries
1 participant
@jmid