Streamlined the getting started #126
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #126 +/- ##
=======================================
Coverage 88.44% 88.44%
=======================================
Files 38 38
Lines 528 528
Branches 2 2
=======================================
Hits 467 467
Misses 61 61Continue to review full report at Codecov.
|
juanpedromoreno
approved these changes
May 9, 2017
docs/src/main/tut/docs.md
Outdated
|
|
||
| ```tut:silent | ||
| val user1 = Github(accessToken).users.get("rafaparadela") | ||
| ``` | ||
|
|
||
| user1 in this case `Free[GHException Xor GHResult[User], User]` and we can run (`foldMap`) with `exec[M[_], C]` where `M[_]` represent any type container that implements `MonadError[M, Throwable]`, for instance `cats.Eval`; and C represents a valid implementation of an HttpClient. The previously mentioned implicit classes carry already set up instances for working with `scalaj` (for JVM-compatible apps) and `roshttp` (for scala-js-compatible apps). Take into account that in the latter case, you can only use `Future` in the place of `M[_]`: | ||
| `user1` in this case `Free[GHException Xor GHResult[User], User]` which we can run (`foldMap`) with |
There was a problem hiding this comment.
- `user1` in this case `Free[GHException Xor GHResult[User], User]` which we
+ `user1` in this case `Free[GitHub4s, Either[GHException, GHResult[User]]]` which weThere was a problem hiding this comment.
Actually, it's a GHIO[GHResponse[User]], if we consider type aliases:
type GHIO[A] = Free[GitHub4s, A]
type GHResponse[A] = Either[GHException, GHResult[A]]
|
@juanpedromoreno Thanks for your review, I think I've clarified things in 84b7246 👍 |
fedefernandez
approved these changes
May 10, 2017
BenFradet
force-pushed
the
bf-getting-started
branch
from
84b7246
to
8142610
Compare
|
@fedefernandez good to go 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.