Make Seed::merged deprecated

dakujem · Mar 27, 2024 · 4fe9d4f · 4fe9d4f
1 parent 5a3c111
commit 4fe9d4f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/changelog.md b/changelog.md
@@ -9,7 +9,8 @@ Please report any issues.
 
 ## v1.1.x
 
-- Added `Seed::chain` method for iterable collection chaining: the new method takes over `Seed::merged` which becomes its alias.
+- Added `Seed::chain` method for iterable collection chaining: the new method takes over `Seed::merged` which becomes its alias for backward compatibility.
+- Deprecated `Seed::merged`, use `Seed::chain` instead.
 
 
 ## v1.0

diff --git a/src/Seed.php b/src/Seed.php
@@ -23,7 +23,9 @@ final class Seed
 {
     /**
      * Chain multiple iterable collections into a single one.
-     * The input collections are not actually merged, but a generator is produced.
+     *
+     * The input collections are not actually merged,
+     * but a generator that iterates over all the elements of all the input collections is returned.
      *
      * Can be used to prepend or append data from multiple source collections.
      */
@@ -39,6 +41,8 @@ public static function chain(iterable ...$input): Generator
      *
      * Creates a "merged" iterable from multiple collections.
      * The input collections are not actually merged, but a generator is produced.
+     *
+     * @deprecated Use `Seed::chain` method.
      */
     public static function merged(iterable ...$input): Generator
     {