Fix scaladoc and run doc generation in CI

zio · Oct 1, 2019 · 9fe4f10 · 9fe4f10
1 parent 80d4b9a
commit 9fe4f10
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -21,7 +21,7 @@ jobs:
       - checkout
       - restore_cache:
           key: sbt-cache
-      - run: sbt ++2.12.10! test
+      - run: sbt ++2.12.10! test packageDoc
       - save_cache:
           key: sbt-cache
           paths:
@@ -49,7 +49,7 @@ jobs:
       - checkout
       - restore_cache:
           key: sbt-cache
-      - run: sbt ++2.11.12! test
+      - run: sbt ++2.11.12! test packageDoc
       - save_cache:
           key: sbt-cache
           paths:

diff --git a/src/main/scala/zio/kafka/client/Consumer.scala b/src/main/scala/zio/kafka/client/Consumer.scala
@@ -125,15 +125,15 @@ object Consumer {
    *
    * val consumerIO = Consumer.consumeWith[Environment, String, String](settings, subscription) { case (key, value) =>
    *   // Process the received record here
-   *   putStrLn(s"Received record: ${key}: ${value}")
+   *   putStrLn(s"Received record: \${key}: \${value}")
    * }
    * }}}
    *
    * @param settings Settings for creating a [[Consumer]]
    * @param subscription Topic subscription parameters
    * @param f Function that returns the effect to execute for each message. It is passed the key and value
-   * @tparam K Type of keys (an implicit [[Serde]] should be in scope)
-   * @tparam V Type of values (an implicit [[Serde]] should be in scope)
+   * @tparam K Type of keys (an implicit `Serde` should be in scope)
+   * @tparam V Type of values (an implicit `Serde` should be in scope)
    * @return Effect that completes with a unit value only when interrupted. May fail when the [[Consumer]] fails.
    */
   def consumeWith[R, K: Serde, V: Serde](