Fix confusing documentation for Media::setNewOrder method (#3759)

spatie · Jan 6, 2025 · 63c6aed · 63c6aed
1 parent d80d47e
commit 63c6aed
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/advanced-usage/ordering-media.md b/docs/advanced-usage/ordering-media.md
@@ -10,9 +10,10 @@ You can easily reorder a list of media by calling  ̀Media::setNewOrder`:
 ```php
  /**
   * This function reorders the records: the record with the first id in the array
-  * will get order 11, the record with the second id will get order 2, ...
+  * will get the starting order (defaults to 1), the record with the second id
+  * will get the starting order + 1, and so on.
   *
-  * A starting order number can be optionally supplied (defaults to 1).
+  * A starting order number can be optionally supplied.
   *
   * @param array $ids
   * @param int $startOrder

diff --git a/src/MediaCollections/Models/Concerns/IsSorted.php b/src/MediaCollections/Models/Concerns/IsSorted.php
@@ -27,7 +27,8 @@ public function scopeOrdered(Builder $query): Builder
 
     /*
      * This function reorders the records: the record with the first id in the array
-     * will get order 1, the record with the second it will get order 2, ...
+     * will get the starting order (defaults to 1), the record with the second id
+     * will get the starting order + 1, and so on.
      *
      * A starting order number can be optionally supplied.
      */