From baa21f8e09a1736a1a668221b0e1ff083655ebb3 Mon Sep 17 00:00:00 2001
From: Matt Mayer <152770+matthewmayer@users.noreply.github.com>
Date: Tue, 6 Feb 2024 15:12:17 +0700
Subject: docs: clarify that the result of faker.date.betweens() is sorted
 (#2635)

---
 src/modules/date/index.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'src/modules')

diff --git a/src/modules/date/index.ts b/src/modules/date/index.ts
index 9b96e704..9e8002d2 100644
--- a/src/modules/date/index.ts
+++ b/src/modules/date/index.ts
@@ -409,7 +409,7 @@ export class SimpleDateModule extends SimpleModuleBase {
   }
 
   /**
-   * Generates random dates between the given boundaries.
+   * Generates random dates between the given boundaries. The dates will be returned in an array sorted in chronological order.
    *
    * @param options The optional options object.
    * @param options.from The early date boundary.
-- 
cgit v1.2.3