Skip to content

Commit

Permalink
doc formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ValdemarGr committed Aug 30, 2023
1 parent 58ad710 commit dd0ceb2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import gql._
import gql.preparation._
import cats.effect.std.Supervisor

/** The [[QueryInterpreter]] will prepare a query for execution by inspecting the ast and planning the query accordingly.
* Once all inputs have been prepared, the execution AST is passed to the [[SubqueryInterpreter]] for evaluation.
/** The [[QueryInterpreter]] will prepare a query for execution by inspecting the ast and planning the query accordingly. Once all inputs
* have been prepared, the execution AST is passed to the [[SubqueryInterpreter]] for evaluation.
*/
trait QueryInterpreter[F[_]] {
import QueryInterpreter._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ import fs2.Stream
import scala.concurrent.duration.FiniteDuration

/** The [[StreamInterpreter]] is resposible for:
* - Wireing together results for a query.
* - Handling incoming asynchronous events.
* - Handling resource lifetimes.
*
* For actual query excution, take a look at [[QueryInterpreter]].
* - Wireing together results for a query.
* - Handling incoming asynchronous events.
* - Handling resource lifetimes.
*
* For actual query excution, take a look at [[QueryInterpreter]].
*/
trait StreamInterpreter[F[_]] {
import StreamInterpreter._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ import io.circe.syntax._
import gql._

/** The [[SubqueryInterpreter]] recursively runs through the AST and performs a multitude of tasks:
* - Runs the [[Resolver]]/[[Step]]s defined in the query.
* - Accumulates errors that occur during the evaluation of the query.
* - Logs streams that have been subscribed to.
* - Batches computations that have been marked as batchable.
*/
* - Runs the [[Resolver]]/[[Step]]s defined in the query.
* - Accumulates errors that occur during the evaluation of the query.
* - Logs streams that have been subscribed to.
* - Batches computations that have been marked as batchable.
*/
trait SubqueryInterpreter[F[_]] {
type W[A] = WriterT[F, Chain[EvalFailure], A]

Expand Down

0 comments on commit dd0ceb2

Please sign in to comment.