scaladocs

7mind · Nov 28, 2023 · d4ca060 · d4ca060
1 parent e88220f
commit d4ca060
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/distage/distage-extension-logstage/src/main/scala/izumi/logstage/distage/LogIOModule.scala b/distage/distage-extension-logstage/src/main/scala/izumi/logstage/distage/LogIOModule.scala
@@ -10,6 +10,8 @@ import logstage.{LogCreateIO, LogIO, LogRouter, UnsafeLogIO}
   * Add a `LogIO[F]` component and others, depending on an existing `IzLogger`
   *
   * To setup `IzLogger` at the same time, use `apply` with parameters
+  *
+  * Depends on `IzLogger`
   */
 class LogIOModule[F[_]: TagK] extends ModuleDef {
   make[LogIO[F]]
@@ -31,7 +33,10 @@ object LogIOModule {
   }
 }
 
-/** [[LogIOModule]] for bifunctors */
+/** [[LogIOModule]] for bifunctors
+  *
+  * Depends on `IzLogger`
+  */
 class LogIO2Module[F[_, _]: TagKK] extends LogIOModule[F[Nothing, _]]
 
 object LogIO2Module {
@@ -41,7 +46,10 @@ object LogIO2Module {
   }
 }
 
-/** [[LogIOModule]] for trifunctors */
+/** [[LogIOModule]] for trifunctors
+  *
+  * Depends on `IzLogger`
+  */
 class LogIO3Module[F[_, _, _]: TagK3] extends LogIOModule[F[Any, Nothing, _]]
 
 object LogIO3Module {

diff --git a/doc/microsite/src/main/tut/distage/basics.md b/doc/microsite/src/main/tut/distage/basics.md
@@ -1522,6 +1522,7 @@ final class PetStoreBusinessLogic[F[+_, +_]: Error2](
   log: LogIO2[F],
 ) {
   private val contextLog = log.withCustomContext("requestId" -> requestId)
+
   def buyPetLogic(petId: PetId, payment: Int): F[TransactionFailure, Pet] = {
     for {
       pet <- petStoreReposistory.findPet(petId).fromOption(TransactionFailure.NoSuchPet)