From 8357137ee85251a7086ad5a332097de2118abef8 Mon Sep 17 00:00:00 2001
From: TheArrayser <thearrayser@cringe-studios.com>
Date: Fri, 30 Jun 2023 23:22:34 +0200
Subject: [PATCH] Improved docs for getPin

---
 .../com/cringe_studios/cringe_authenticator_library/OTP.java    | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/main/java/com/cringe_studios/cringe_authenticator_library/OTP.java b/src/main/java/com/cringe_studios/cringe_authenticator_library/OTP.java
index 849b7ad..28595b6 100644
--- a/src/main/java/com/cringe_studios/cringe_authenticator_library/OTP.java
+++ b/src/main/java/com/cringe_studios/cringe_authenticator_library/OTP.java
@@ -57,7 +57,7 @@ public abstract class OTP {
 	/**
 	 * 
 	 * @return s the current pin, as calculated by the counter or the current time, unless it
-	 * @throws an OTPException
+	 * @throws an OTPException, which is either thrown, if you somehow create an OTP with an invalid key, despite the checks in the instaciate method, or if your platform does not support the hashing algorithm you selected
 	 */
 	public abstract String getPin() throws OTPException;