fix documentation of take function

Quillraven · Dec 20, 2024 · 646ef45 · 646ef45
1 parent ce471b0
commit 646ef45
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/src/commonMain/kotlin/com/github/quillraven/fleks/collection/entityBag.kt b/src/commonMain/kotlin/com/github/quillraven/fleks/collection/entityBag.kt
@@ -413,7 +413,7 @@ interface EntityBag {
     fun singleOrNull(predicate: (Entity) -> Boolean): Entity?
 
     /**
-     * Returns a [List] containing the first [n] [entities][Entity].
+     * Returns a [List] containing the first [n][] [entities][Entity].
      */
     fun take(n: Int): EntityBag
 }
@@ -1249,7 +1249,7 @@ class MutableEntityBag(
     }
 
     /**
-     * Returns a [List] containing the first [n] [entities][Entity].
+     * Returns a [List] containing the first [n][] [entities][Entity].
      */
     override fun take(n: Int): EntityBag {
         val result = MutableEntityBag(max(min(n, size), 0))

diff --git a/src/commonMain/kotlin/com/github/quillraven/fleks/family.kt b/src/commonMain/kotlin/com/github/quillraven/fleks/family.kt
@@ -526,7 +526,7 @@ data class Family(
     fun singleOrNull(predicate: (Entity) -> Boolean): Entity? = mutableEntities.singleOrNull(predicate)
 
     /**
-     * Returns a [List] containing the first [n] [entities][Entity].
+     * Returns a [List] containing the first [n][] [entities][Entity].
      */
     fun take(n: Int): EntityBag = mutableEntities.take(n)