Add: Add docstring from useUserName

Explain using useUserName.
greenbone · Mar 6, 2025 · 476643f · 476643f
1 parent f26ee10
commit 476643f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/web/hooks/useUserName.js b/src/web/hooks/useUserName.js
@@ -7,6 +7,11 @@ import {useSelector, useDispatch} from 'react-redux';
 import {setUsername} from 'web/store/usersettings/actions';
 import {getUsername} from 'web/store/usersettings/selectors';
 
+/**
+ * Custom hook to get and set the username.
+ *
+ * @returns {Array} An array containing the current username and a function to set the username.
+ */
 const useUserName = () => {
   const dispatch = useDispatch();
   return [