Skip to content

Commit e0ba903

Browse files
author
Javier de Silóniz Sandino
committed
Update docs to reflect changes
1 parent a561e79 commit e0ba903

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

docs/src/main/tut/docs.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ WIP: Every Github4s api returns a `Free[GHResponse[A], A]` where `GHResponse[A]`
3131
case class GHResult[A](result: A, statusCode: Int, headers: Map[String, IndexedSeq[String]])
3232
```
3333

34-
For getting an user
34+
To get an user
3535

3636
```tut:silent
3737
val user1 = Github(accessToken).users.get("rafaparadela")
@@ -45,7 +45,7 @@ import github4s.Github._
4545
import scalaj.http._
4646
4747
object ProgramEval {
48-
val u1 = user1.exec[Eval, HttpResponse[String]].value
48+
val u1 = user1.exec[Eval, HttpResponse[String]]().value
4949
}
5050
5151
```
@@ -71,7 +71,7 @@ import cats.Id
7171
import scalaj.http._
7272
7373
object ProgramId {
74-
val u2 = Github(accessToken).users.get("raulraja").exec[Id, HttpResponse[String]]
74+
val u2 = Github(accessToken).users.get("raulraja").exec[Id, HttpResponse[String]]()
7575
}
7676
```
7777

@@ -86,7 +86,8 @@ import scala.concurrent.Await
8686
import scalaj.http._
8787
8888
object ProgramFuture {
89-
val u3 = Github(accessToken).users.get("dialelo").exec[Future, HttpResponse[String]]
89+
// execFuture[C] is a convenience access to exec[Future, C]
90+
val u3 = Github(accessToken).users.get("dialelo").execFuture[HttpResponse[String]]()
9091
Await.result(u3, 2.seconds)
9192
}
9293
```
@@ -100,7 +101,7 @@ import scalaj.http._
100101
import github4s.jvm.Implicits._
101102
102103
object ProgramTask {
103-
val u4 = Github(accessToken).users.get("franciscodr").exec[Task, HttpResponse[String]]
104+
val u4 = Github(accessToken).users.get("franciscodr").exec[Task, HttpResponse[String]]()
104105
u4.attemptRun
105106
}
106107
```
@@ -120,7 +121,9 @@ val accessToken = sys.props.get("token")
120121

121122
```tut:book
122123
object ProgramEval {
123-
val user1 = Github(accessToken).users.get("rafaparadela").exec[Eval, HttpResponse[String]].value
124+
// exec methods let users to include optional headers for any GitHub API request:
125+
val userHeaders = Map("user-agent" -> "github4s")
126+
val user1 = Github(accessToken).users.get("rafaparadela").exec[Eval, HttpResponse[String]](userHeaders).value
124127
}
125128
126129
ProgramEval.user1 should be ('right)

0 commit comments

Comments
 (0)