-
Notifications
You must be signed in to change notification settings - Fork 407
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.
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
Add docs for Gen #783
Add docs for Gen #783
Conversation
* - [[Gen$.containerOfN containerOfN]] - Generates a collection of at most ''n'' elements | ||
* - [[Gen$.nonEmptyContainerOf nonEmptyContainerOf]] - Generates a non-empty collection | ||
* - [[Gen$.either either]] - Generate a disjoint union of [[scala.util.Either]] | ||
* - [[Gen$.infiniteLazyList infiniteLazyList]] - Generates an infinite lazy list |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm getting this error locally when building the docs with Scala 2.12.
Could not find any member to link for "Gen$.infiniteLazyList".
Since we have fatal warnings enabled for 2.12, that's to be expected... I'm just surprised it's not getting caught by the GitHub build.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The package
task does not run doc
; we could add it to the build script.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See #792
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, want me to rebase, then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rebasing shows that the error does happen in GitHub Actions when running the doc
task. Phew.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like fatal warnings, so I'll just delete this line.
Fixes the fatal warning from Scaladoc in the 2.12 build
I've upload this docs page to my personal GitHub Pages if anyone wants to review: https://ashawley.github.io/scalacheck/api/scalacheck_2.13-1.15.4-SNAPSHOT/org/scalacheck/Gen.html |
There's a few strange issues with Dottydoc, but I uploaded it as well: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff!
Fixes #773.