docs: update documentation for 2.0 release

Author: MateuszKubuszok

chimney/src/main/scala-2/io/scalaland/chimney/dsl/package.scala

@@ -30,8 +30,8 @@ package object dsl {
   implicit def TransformationMapPathOps[M[_, _], K, V](a: M[K, V]): syntax.TransformationMapPathOps[M, K, V] =
     syntax.TransformationMapPathOps(a)
 
-  // Extension methods in dsl.* summon TypeClass.AutoDerived while extension methods in syntax.* summon TypeClass.
-  // This help us preserve legacy behavior in dsl code while keeping stricter separation in auto/syntax imports.
+  // Keep the legacy dsl.* signatures using the AutoDerived compatibility aliases; syntax.* uses the type classes
+  // directly.
 
   /** Provides transformer operations on values of any type.
     *
@@ -50,7 +50,7 @@ package object dsl {
       * method.
       *
       * @see
-      *   [[io.scalaland.chimney.Transformer.AutoDerived#deriveAutomatic]] for default implicit instance
+      *   [[io.scalaland.chimney.Transformer#derive]] for default implicit instance
       *
       * @tparam To
       *   target type
@@ -82,12 +82,12 @@ package object dsl {
       * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
       *
       * @see
-      *   [[io.scalaland.chimney.PartialTransformer.AutoDerived#deriveAutomatic]] for default implicit instance
+      *   [[io.scalaland.chimney.PartialTransformer#derive]] for default implicit instance
       *
       * @tparam To
       *   result target type of partial transformation
       * @param transformer
-      *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+      *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
       * @return
       *   partial transformation result value of target type `To`
       *
@@ -104,14 +104,14 @@ package object dsl {
       * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
       *
       * @see
-      *   [[io.scalaland.chimney.PartialTransformer.AutoDerived#deriveAutomatic]] for default implicit instance
+      *   [[io.scalaland.chimney.PartialTransformer#derive]] for default implicit instance
       *
       * @tparam To
       *   result target type of partial transformation
       * @param failFast
       *   should fail as early as the first set of errors appear
       * @param transformer
-      *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+      *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
       * @return
       *   partial transformation result value of target type `To`
       *
@@ -140,7 +140,7 @@ package object dsl {
       * method.
       *
       * @see
-      *   [[io.scalaland.chimney.Patcher.AutoDerived#deriveAutomatic]] for default implicit instance
+      *   [[io.scalaland.chimney.Patcher#derive]] for default implicit instance
       *
       * @tparam Patch
       *   type of patch object

chimney/src/main/scala-2/io/scalaland/chimney/syntax/package.scala

@@ -10,8 +10,8 @@ import scala.annotation.{compileTimeOnly, unused}
   */
 package object syntax {
 
-  // Extension methods in dsl.* summon TypeClass.AutoDerived while extension methods in syntax.* summon TypeClass.
-  // This help us preserve legacy behavior in dsl code while keeping stricter separation in auto/syntax imports.
+  // Keep the legacy dsl.* signatures using the AutoDerived compatibility aliases; syntax.* uses the type classes
+  // directly.
 
   /** Provides transformer operations on values of any type.
     *
@@ -30,7 +30,7 @@ package object syntax {
       * method.
       *
       * @see
-      *   [[io.scalaland.chimney.auto#deriveAutomaticTransformer]] for default implicit instance
+      *   [[io.scalaland.chimney.Transformer#derive]] for deriving an implicit instance
       *
       * @tparam To
       *   target type
@@ -62,12 +62,12 @@ package object syntax {
       * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
       *
       * @see
-      *   [[io.scalaland.chimney.auto#deriveAutomaticPartialTransformer]] for default implicit instance
+      *   [[io.scalaland.chimney.PartialTransformer#derive]] for deriving an implicit instance
       *
       * @tparam To
       *   result target type of partial transformation
       * @param transformer
-      *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+      *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
       * @return
       *   partial transformation result value of target type `To`
       *
@@ -84,14 +84,14 @@ package object syntax {
       * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
       *
       * @see
-      *   [[io.scalaland.chimney.auto#deriveAutomaticPartialTransformer]] for default implicit instance
+      *   [[io.scalaland.chimney.PartialTransformer#derive]] for deriving an implicit instance
       *
       * @tparam To
       *   result target type of partial transformation
       * @param failFast
       *   should fail as early as the first set of errors appear
       * @param transformer
-      *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+      *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
       * @return
       *   partial transformation result value of target type `To`
       *
@@ -120,7 +120,7 @@ package object syntax {
       * method.
       *
       * @see
-      *   [[io.scalaland.chimney.auto#deriveAutomaticPatcher]] for default implicit instance
+      *   [[io.scalaland.chimney.Patcher#derive]] for deriving an implicit instance
       *
       * @tparam Patch
       *   type of patch object

chimney/src/main/scala-3/io/scalaland/chimney/dsl/dsl.scala

@@ -14,8 +14,8 @@ export io.scalaland.chimney.syntax.{
   matchingSome
 }
 
-// Extension methods in dsl.* summon TypeClass.AutoDerived while extension methods in syntax.* summon TypeClass.
-// This helps us preserve legacy behavior in dsl code while keeping stricter separation in auto/syntax imports.
+// Keep the legacy dsl.* signatures using the AutoDerived compatibility aliases; syntax.* uses the type classes
+// directly.
 
 /** Provides transformer operations on values of any type.
   *
@@ -30,8 +30,7 @@ extension [From](source: From) {
 
   /** Performs in-place transformation of captured source value to target type.
     *
-    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.dsl.TransformerOps#into]]
-    * method.
+    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.inlined.into]] method.
     *
     * @see
     *   [[io.scalaland.chimney.Transformer#derive]] for default implicit instance
@@ -62,16 +61,15 @@ extension [From](source: From) {
 
   /** Performs in-place partial transformation of captured source value to target type.
     *
-    * If you want to customize transformer behavior, consider using
-    * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
+    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.inlined.intoPartial]] method.
     *
     * @see
     *   [[io.scalaland.chimney.PartialTransformer#derive]] for default implicit instance
     *
     * @tparam To
     *   result target type of partial transformation
     * @param transformer
-    *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+    *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
     * @return
     *   partial transformation result value of target type `To`
     *
@@ -84,8 +82,7 @@ extension [From](source: From) {
 
   /** Performs in-place partial transformation of captured source value to target type.
     *
-    * If you want to customize transformer behavior, consider using
-    * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
+    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.inlined.intoPartial]] method.
     *
     * @see
     *   [[io.scalaland.chimney.PartialTransformer#derive]] for default implicit instance
@@ -95,7 +92,7 @@ extension [From](source: From) {
     * @param failFast
     *   should fail as early as the first set of errors appear
     * @param transformer
-    *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+    *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
     * @return
     *   partial transformation result value of target type `To`
     *
@@ -111,7 +108,7 @@ extension [From](source: From) {
   *
   * @param obj
   *   wrapped object to patch
-  * @tparam T
+  * @tparam A
   *   type of object to patch
   *
   * @since 0.1.3
@@ -120,8 +117,7 @@ extension [A](obj: A) {
 
   /** Performs in-place patching of wrapped object with provided value.
     *
-    * If you want to customize patching behavior, consider using [[io.scalaland.chimney.dsl.PatcherOps#using using]]
-    * method.
+    * If you want to customize patching behavior, consider using [[io.scalaland.chimney.inlined.using]] method.
     *
     * @see
     *   [[io.scalaland.chimney.Patcher#derive]] for default implicit instance

chimney/src/main/scala-3/io/scalaland/chimney/inlined/inlined.scala

@@ -59,7 +59,7 @@ extension [From](source: From) {
   *
   * @param obj
   *   wrapped object to patch
-  * @tparam T
+  * @tparam A
   *   type of object to patch
   *
   * @since 0.1.3

chimney/src/main/scala-3/io/scalaland/chimney/syntax/syntax.scala

@@ -5,8 +5,8 @@ import io.scalaland.chimney.internal.runtime.{ChimneySelector, IsCollection, IsE
 
 import scala.annotation.unused
 
-// Extension methods in dsl.* summon TypeClass.AutoDerived while extension methods in syntax.* summon TypeClass.
-// This help us preserve legacy behavior in dsl code while keeping stricter separation in auto/syntax imports.
+// Keep the legacy dsl.* signatures using the AutoDerived compatibility aliases; syntax.* uses the type classes
+// directly.
 
 /** Provides transformer operations on values of any type.
   *
@@ -21,11 +21,10 @@ extension [From](source: From) {
 
   /** Performs in-place transformation of captured source value to target type.
     *
-    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.dsl.TransformerOps#into]]
-    * method.
+    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.inlined.into]] method.
     *
     * @see
-    *   [[io.scalaland.chimney.auto#deriveAutomaticTransformer]] for default implicit instance
+    *   [[io.scalaland.chimney.Transformer#derive]] for deriving an implicit instance
     *
     * @tparam To
     *   target type
@@ -52,16 +51,15 @@ extension [From](source: From) {
 
   /** Performs in-place partial transformation of captured source value to target type.
     *
-    * If you want to customize transformer behavior, consider using
-    * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
+    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.inlined.intoPartial]] method.
     *
     * @see
-    *   [[io.scalaland.chimney.auto#deriveAutomaticPartialTransformer]] for default implicit instance
+    *   [[io.scalaland.chimney.PartialTransformer#derive]] for deriving an implicit instance
     *
     * @tparam To
     *   result target type of partial transformation
     * @param transformer
-    *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+    *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
     * @return
     *   partial transformation result value of target type `To`
     *
@@ -74,18 +72,17 @@ extension [From](source: From) {
 
   /** Performs in-place partial transformation of captured source value to target type.
     *
-    * If you want to customize transformer behavior, consider using
-    * [[io.scalaland.chimney.dsl.PartialTransformerOps#intoPartial]] method.
+    * If you want to customize transformer behavior, consider using [[io.scalaland.chimney.inlined.intoPartial]] method.
     *
     * @see
-    *   [[io.scalaland.chimney.auto#deriveAutomaticPartialTransformer]] for default implicit instance
+    *   [[io.scalaland.chimney.PartialTransformer#derive]] for deriving an implicit instance
     *
     * @tparam To
     *   result target type of partial transformation
     * @param failFast
     *   should fail as early as the first set of errors appear
     * @param transformer
-    *   implicit instance of [[io.scalaland.chimney.Transformer]] type class
+    *   implicit instance of [[io.scalaland.chimney.PartialTransformer]] type class
     * @return
     *   partial transformation result value of target type `To`
     *
@@ -110,11 +107,10 @@ extension [A](obj: A) {
 
   /** Performs in-place patching of wrapped object with provided value.
     *
-    * If you want to customize patching behavior, consider using [[io.scalaland.chimney.dsl.PatcherOps#using using]]
-    * method.
+    * If you want to customize patching behavior, consider using [[io.scalaland.chimney.inlined.using]] method.
     *
     * @see
-    *   [[io.scalaland.chimney.auto#deriveAutomaticPatcher]] for default implicit instance
+    *   [[io.scalaland.chimney.Patcher#derive]] for deriving an implicit instance
     *
     * @tparam Patch
     *   type of patch object

chimney/src/main/scala/io/scalaland/chimney/AllowDerivation.scala

@@ -9,7 +9,7 @@ package io.scalaland.chimney
   * A no-op under the default `always-allowed` policy.
   *
   * @see
-  *   [[https://chimney.readthedocs.io Chimney documentation - derivation policy chapter]]
+  *   [[https://chimney.readthedocs.io/cookbook/#derivation-policy-restricting-where-derivation-may-happen Chimney documentation - derivation policy chapter]]
   *
   * @since 2.0.0
   */

chimney/src/main/scala/io/scalaland/chimney/LogDerivation.scala

@@ -7,7 +7,7 @@ package io.scalaland.chimney
   * `debug._` imports.
   *
   * @see
-  *   [[https://chimney.readthedocs.io Chimney documentation - debugging chapter]]
+  *   [[https://chimney.readthedocs.io/troubleshooting/#debug-logging-without-touching-the-code-import-or-scalac-option Chimney documentation - debugging chapter]]
   *
   * @since 2.0.0
   */

chimney/src/main/scala/io/scalaland/chimney/PartialTransformer.scala

@@ -245,10 +245,10 @@ object PartialTransformer extends PartialTransformerLowPriorityImplicits1 {
   def define[From, To]: PartialTransformerDefinition[From, To, TransformerOverrides.Empty, TransformerFlags.Default] =
     new PartialTransformerDefinition(TransformerDefinitionCommons.emptyRuntimeDataStore)
 
-  /** Type class used when you want to allow using automatically derived transformations.
+  /** Compatibility alias retained for source compatibility with Chimney 1.x.
     *
-    * When we want to only allow semiautomatically derived/manually defined instances you should use
-    * [[io.scalaland.chimney.PartialTransformer]].
+    * Since Chimney 2.0.0 automatic and explicitly derived transformations use the same
+    * [[io.scalaland.chimney.PartialTransformer]] type.
     *
     * @see
     *   [[https://chimney.readthedocs.io/cookbook/#automatic-semiautomatic-and-inlined-derivation]] for more details

chimney/src/main/scala/io/scalaland/chimney/Patcher.scala

@@ -65,10 +65,9 @@ object Patcher extends PatcherCompanionPlatform {
   def define[A, Patch]: PatcherDefinition[A, Patch, PatcherOverrides.Empty, PatcherFlags.Default] =
     new PatcherDefinition(PatcherDefinitionCommons.emptyRuntimeDataStore)
 
-  /** Type class used when you want to allow using automatically derived patchings.
+  /** Compatibility alias retained for source compatibility with Chimney 1.x.
     *
-    * When we want to only allow semiautomatically derived/manually defined instances you should use
-    * [[io.scalaland.chimney.Patcher]].
+    * Since Chimney 2.0.0 automatic and explicitly derived patchers use the same [[io.scalaland.chimney.Patcher]] type.
     *
     * @see
     *   [[https://chimney.readthedocs.io/cookbook/#automatic-semiautomatic-and-inlined-derivation]] for more details

chimney/src/main/scala/io/scalaland/chimney/Transformer.scala

@@ -132,10 +132,10 @@ object Transformer extends TransformerLowPriorityImplicits1 {
       : PartialTransformerDefinition[From, To, TransformerOverrides.Empty, TransformerFlags.Default] =
     new PartialTransformerDefinition(TransformerDefinitionCommons.emptyRuntimeDataStore)
 
-  /** Type class used when you want to allow using automatically derived transformations.
+  /** Compatibility alias retained for source compatibility with Chimney 1.x.
     *
-    * When we want to only allow semiautomatically derived/manually defined instances you should use
-    * [[io.scalaland.chimney.Transformer]].
+    * Since Chimney 2.0.0 automatic and explicitly derived transformations use the same
+    * [[io.scalaland.chimney.Transformer]] type.
     *
     * @see
     *   [[https://chimney.readthedocs.io/cookbook/#automatic-semiautomatic-and-inlined-derivation]] for more details