fix deprecation note in scaladocs

typelevel · Dec 18, 2024 · e8d95ee · e8d95ee
1 parent 63111a1
commit e8d95ee
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 16 deletions.
diff --git a/core/src/main/scala/cats/Foldable.scala b/core/src/main/scala/cats/Foldable.scala
@@ -598,8 +598,7 @@ trait Foldable[F[_]] extends UnorderedFoldable[F] with FoldableNFunctions[F] { s
   /**
    * Alias for `traverseVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `traverseVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `traverseVoid`.
    */
   def traverse_[G[_], A, B](fa: F[A])(f: A => G[B])(implicit G: Applicative[G]): G[Unit] =
     traverseVoid(fa)(f)
@@ -627,8 +626,7 @@ trait Foldable[F[_]] extends UnorderedFoldable[F] with FoldableNFunctions[F] { s
   /**
    * Alias for `sequenceVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `sequenceVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `sequenceVoid`.
    */
   def sequence_[G[_]: Applicative, A](fga: F[G[A]]): G[Unit] =
     sequenceVoid(fga)

diff --git a/core/src/main/scala/cats/Parallel.scala b/core/src/main/scala/cats/Parallel.scala
@@ -271,8 +271,7 @@ object Parallel extends ParallelArityFunctions2 {
   /**
    * Alias for `parSequenceVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `parSequenceVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `parSequenceVoid`.
    */
   def parSequence_[T[_]: Foldable, M[_], A](tma: T[M[A]])(implicit P: Parallel[M]): M[Unit] =
     parSequenceVoid(tma)
@@ -289,8 +288,7 @@ object Parallel extends ParallelArityFunctions2 {
   /**
    * Alias for `parTraverseVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `parTraverseVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `parTraverseVoid`.
    */
   def parTraverse_[T[_]: Foldable, M[_], A, B](ta: T[A])(f: A => M[B])(implicit P: Parallel[M]): M[Unit] =
     parTraverseVoid(ta)(f)
@@ -374,8 +372,7 @@ object Parallel extends ParallelArityFunctions2 {
   /**
    * Alias for `parNonEmptySequenceVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `parNonEmptySequenceVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `parNonEmptySequenceVoid`.
    */
   def parNonEmptySequence_[T[_]: Reducible, M[_], A](
     tma: T[M[A]]
@@ -396,8 +393,7 @@ object Parallel extends ParallelArityFunctions2 {
   /**
    * Alias for `parNonEmptyTraverseVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `parNonEmptyTraverseVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `parNonEmptyTraverseVoid`.
    */
   def parNonEmptyTraverse_[T[_]: Reducible, M[_], A, B](
     ta: T[A]

diff --git a/core/src/main/scala/cats/Reducible.scala b/core/src/main/scala/cats/Reducible.scala
@@ -220,8 +220,7 @@ trait Reducible[F[_]] extends Foldable[F] { self =>
   /**
    * Alias for `nonEmptyTraverseVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `nonEmptyTraverseVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `nonEmptyTraverseVoid`.
    */
   def nonEmptyTraverse_[G[_], A, B](fa: F[A])(f: A => G[B])(implicit G: Apply[G]): G[Unit] =
     nonEmptyTraverseVoid(fa)(f)
@@ -239,8 +238,7 @@ trait Reducible[F[_]] extends Foldable[F] { self =>
   /**
    * Alias for `nonEmptySequenceVoid`.
    *
-   * @deprecated this method should be considered as deprecated;
-   *             refrain from using this method and consider switching to `nonEmptySequenceVoid`.
+   * @deprecated this method should be considered as deprecated and replaced by `nonEmptySequenceVoid`.
    */
   def nonEmptySequence_[G[_], A](fga: F[G[A]])(implicit G: Apply[G]): G[Unit] =
     nonEmptySequenceVoid(fga)