add more detailed comments

retraigo · Jun 2, 2023 · 1189adb · 1189adb
1 parent 53dcbab
commit 1189adb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/fortuna.ts b/src/fortuna.ts
@@ -52,6 +52,10 @@ export class GachaMachine<T> {
    * const machine = new GachaMachine(items);
    * machine.get(11)
    * ```
+   * 
+   * You can roll `n` distinct items using the `get(n, true)` format.
+   * However, rolling distinct items does not mutate the pool.
+   * The items rolled are only distinct within the `n` items.
    */
   get(count: number, distinct = false) {
     if (distinct && count > this.#items.length) {