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 documentation for Scala 3 derivation #1069

Merged
merged 2 commits into from Jun 8, 2021
Merged

Conversation

ruippeixotog
Copy link
Member

@ruippeixotog ruippeixotog commented Jun 7, 2021

As titled.

@heksesang, if you could take a quick look it would be great.

PureConfig has some limited support for derivation of `ConfigReader` instances. In order to enable it, the relevant
extensions must be imported:

```scala
Copy link
Member Author

Choose a reason for hiding this comment

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

Unfortunately we can't run any of this through mdoc as our website depends on pureconfig-generic, which isn't available in Scala 3. Instead, I ran this on core/console and copied the outputs here.

@github-actions
Copy link

github-actions bot commented Jun 7, 2021

Warning: the content of the PureConfig website changed with this pull request. This may be intentional (as is the case when sbt-microsites is updated or some breaking change occurs) or may be an unexpected change in the library's behavior. Please check the logs of the Diff Website job ("Build and compare website" step) in GitHub Actions to see the differences.

@heksesang
Copy link
Contributor

LGTM, except that one typo I pointed out. :)

Copy link
Member

@jcazevedo jcazevedo left a comment

Choose a reason for hiding this comment

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

Other than a small typo, this looks good to me!

docs/docs/docs/scala-3-derivation.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Jun 8, 2021

Warning: the content of the PureConfig website changed with this pull request. This may be intentional (as is the case when sbt-microsites is updated or some breaking change occurs) or may be an unexpected change in the library's behavior. Please check the logs of the Diff Website job ("Build and compare website" step) in GitHub Actions to see the differences.

Copy link
Member

@jcazevedo jcazevedo left a comment

Choose a reason for hiding this comment

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

Thanks!

@jcazevedo jcazevedo merged commit 98d1308 into master Jun 8, 2021
@jcazevedo jcazevedo deleted the scala-3.0-derivation-docs branch June 8, 2021 22:45
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.

None yet

3 participants