From 0b7e74a11480155a1080046cc6ddca0410868bb3 Mon Sep 17 00:00:00 2001
From: Mateusz Kubuszok <mateusz.kubuszok@gmail.com>
Date: Tue, 2 Jan 2024 14:05:49 +0100
Subject: [PATCH] Add links in scaladocs to new section

---
 .../scala-2/io/scalaland/chimney/partial/syntax/package.scala | 3 +++
 .../scala-3/io/scalaland/chimney/partial/syntax/syntax.scala  | 4 ++++
 .../main/scala/io/scalaland/chimney/partial/AsResult.scala    | 2 ++
 3 files changed, 9 insertions(+)

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
index 3935273c4..6429e36bf 100644
--- 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
index 08c6e7dd2..f8c0d4f0d 100644
--- 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
index 11efa05b6..d6a0b3443 100644
--- 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