From 6a9ca8abec3d8956b45a8607a5371b61de85378a Mon Sep 17 00:00:00 2001
From: ST-DDT <ST-DDT@gmx.de>
Date: Wed, 16 Oct 2024 20:56:03 +0200
Subject: [PATCH] docs: iban might be invalid due to country specific rules
 (#3175)

---
 src/modules/finance/index.ts | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts
index 4c84fe4c148..0e9a6883994 100644
--- a/src/modules/finance/index.ts
+++ b/src/modules/finance/index.ts
@@ -816,7 +816,9 @@ export class FinanceModule extends ModuleBase {
   }
 
   /**
-   * Generates a random iban.
+   * Generates a random IBAN.
+   *
+   * Please note that the generated IBAN might be invalid due to randomly generated bank codes/other country specific validation rules.
    *
    * @param options An options object.
    * @param options.formatted Return a formatted version of the generated IBAN. Defaults to `false`.