Add links in scaladocs to new section

scalalandio · Jan 2, 2024 · 0b7e74a · 0b7e74a
1 parent 5e9d5a0
commit 0b7e74a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/chimney/src/main/scala-2/io/scalaland/chimney/partial/syntax/package.scala b/chimney/src/main/scala-2/io/scalaland/chimney/partial/syntax/package.scala
@@ -3,6 +3,8 @@ package io.scalaland.chimney.partial
 package object syntax {
 
   /** Provides operations lifting [[scala.Option]] to [[io.scalaland.chimney.partial.Result]].
+    *
+    * @see [[https://chimney.readthedocs.io/supported-transformations/#partialresult-utilities]] for more details
     *
     * @tparam A successful value type
     * @param option value to convert
@@ -44,6 +46,7 @@ package object syntax {
 
   /** Provides operations lifting `F[A]` to [[io.scalaland.chimney.partial.Result]].
     *
+    * @see [[https://chimney.readthedocs.io/supported-transformations/#partialresult-utilities]] for more details
     * @tparam F wrapper type
     * @tparam A successful value type
     * @param fa value to convert

diff --git a/chimney/src/main/scala-3/io/scalaland/chimney/partial/syntax/syntax.scala b/chimney/src/main/scala-3/io/scalaland/chimney/partial/syntax/syntax.scala
@@ -3,6 +3,8 @@ package io.scalaland.chimney.partial.syntax
 import io.scalaland.chimney.partial.{AsResult, Error, Result}
 
 /** Provides operations lifting [[scala.Option]] to [[io.scalaland.chimney.partial.Result]].
+  *
+  * @see [[https://chimney.readthedocs.io/supported-transformations/#partialresult-utilities]] for more details
   *
   * @tparam A successful value type
   * @param option value to convert
@@ -42,6 +44,8 @@ extension [A](option: Option[A])
   def orThrowableAsResult(onEmpty: => Throwable): Result[A] = Result.fromOptionOrThrowable(option, onEmpty)
 
 /** Provides operations lifting `F[A]` to [[io.scalaland.chimney.partial.Result]].
+  *
+  * @see [[https://chimney.readthedocs.io/supported-transformations/#partialresult-utilities]] for more details
   *
   * @tparam F wrapper type
   * @tparam A successful value type

diff --git a/chimney/src/main/scala/io/scalaland/chimney/partial/AsResult.scala b/chimney/src/main/scala/io/scalaland/chimney/partial/AsResult.scala
@@ -7,6 +7,8 @@ import scala.util.Try
   * Should define logic what is considered successful value, what is considered failed value and how to convert it into
   * [[io.scalaland.chimney.partial.Result]].
   *
+  * @see [[https://chimney.readthedocs.io/supported-transformations/#total-transformers-vs-partialtransformers]]
+  * @see [[https://chimney.readthedocs.io/supported-transformations/#partialresult-utilities]]
   * @tparam F generic data type which should be convertible to `Result` for all possible values
   *
   * @since 0.8.5