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.

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

Merged
merged 2 commits into from
Apr 11, 2021
Merged

Add docs for Gen #783

merged 2 commits into from
Apr 11, 2021

Conversation

ashawley
Copy link
Contributor

@ashawley ashawley commented Apr 7, 2021

Fixes #773.

@larsrh larsrh added this to the 1.15.4 milestone Apr 10, 2021
* - [[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
Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #792

Copy link
Contributor Author

@ashawley ashawley Apr 10, 2021

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?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

@ashawley ashawley mentioned this pull request Apr 10, 2021
Fixes the fatal warning from Scaladoc in the 2.12 build
@ashawley
Copy link
Contributor Author

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

@ashawley
Copy link
Contributor Author

There's a few strange issues with Dottydoc, but I uploaded it as well:

https://ashawley.github.io/scalacheck/api/scalacheck_3.0.0-RC2-1.15.4-SNAPSHOT/api/org/scalacheck/Gen.html

Copy link
Contributor

@larsrh larsrh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff!

@larsrh larsrh merged commit a28478b into typelevel:main Apr 11, 2021
@ashawley ashawley deleted the gen-doc branch April 16, 2021 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for Gen
2 participants