From 997975795ae56b537c6d2a1cb1ca9538823259bd Mon Sep 17 00:00:00 2001
From: Gimleux <56401687+Gimleux@users.noreply.github.com>
Date: Mon, 18 Apr 2022 20:05:06 +0200
Subject: [PATCH] add docComments for PasswordStrengthBar

---
 src/components/pages/User/PasswordStrengthBar.tsx | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/components/pages/User/PasswordStrengthBar.tsx b/src/components/pages/User/PasswordStrengthBar.tsx
index 40ad8164..85d927d8 100644
--- a/src/components/pages/User/PasswordStrengthBar.tsx
+++ b/src/components/pages/User/PasswordStrengthBar.tsx
@@ -7,9 +7,10 @@ const PasswordStrengthBar = React.lazy(
 )
 
 /**
+ * PasswordStrengthBarWrapper component's parameter type.
  * @typedef {Object} PasswordStrengthBarWrapperArgs
- * @property {string} currentPassword
- * @property {(number, PasswordFeedback) => void} scoreChangeCallback
+ * @property {string} currentPassword The password to check.
+ * @property {(number, PasswordFeedback) => void} scoreChangeCallback A function which receives the password's strength and reacts to it.
  */
 type PasswordStrengthBarWrapperArgs = {
     currentPassword: string