Skip to content

feat: Add module pureconfig with tests and basic documentation #1

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

Merged
merged 6 commits into from
Sep 20, 2019

Conversation

jakubjanecek
Copy link
Collaborator

feat: Add module example to show how to use the code

build: Tweak the build so that it all works together well

feat: Add module example to show how to use the code

build: Tweak the build so that it all works together well
@jakubjanecek jakubjanecek self-assigned this Sep 19, 2019
@jakubjanecek jakubjanecek added the feature New feature or request label Sep 19, 2019
@jakubjanecek jakubjanecek added this to the v0.1 milestone Sep 19, 2019
Copy link
Member

@augi augi left a comment

Choose a reason for hiding this comment

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

It's not clear to me why I should use this module instead of using pureconfig directly. Could you please describe the reasons in the README? Possibly also show an example how the module simplifies the usage etc.
Thanks!

@jakubjanecek
Copy link
Collaborator Author

@augi This module is very simple so the benefit is not substantial. It gives you 3 things: wrapping in Sync, improved error message and conventional (according to this project) way of doing things. Of course you can use pureconfig directly, nothing against that, but you will have to write Sync[Task].delay repeatedly and you might want to wrap this functionality into some class which is basically what this module is doing.

I will write some documentation covering the design of this project but not as part of this PR. Alright?

# Conflicts:
#	project/plugins.sbt
@jakubjanecek jakubjanecek requested a review from augi September 20, 2019 10:33
@jakubjanecek jakubjanecek merged commit aba35c6 into master Sep 20, 2019
@jakubjanecek jakubjanecek deleted the feat/pureconfig branch September 24, 2019 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Development

Successfully merging this pull request may close these issues.

4 participants