docs: add docstring for useTranslatedString hook

sparcs-kaist · Mar 14, 2024 · 0c68771 · 0c68771
1 parent 6738c72
commit 0c68771
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/hooks/useTranslatedString.tsx b/src/hooks/useTranslatedString.tsx
@@ -1,5 +1,12 @@
 import { useTranslation } from 'react-i18next';
 
+/**
+ * Custom hook that returns a function for translating strings based on the current language.
+ *
+ * @returns {function} A function that takes an object and a key and returns the translated string.
+ * @example const translate = useTranslatedString();
+ *          const translatedString = translate(review.lecture, 'title');
+ */
 export const useTranslatedString = () => {
   const { i18n } = useTranslation();