chore: add comments clarifying potentially confusing terms (#7694)

* chore: add comments clarifying potentially confusing terms * feat: remove undocumented param and return --------- Co-authored-by: Kevin Foong <[email protected]>
opengovsg · Sep 25, 2024 · 320cbd7 · 320cbd7
1 parent df2e6b8
commit 320cbd7
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/frontend/src/features/admin-form/template/UseTemplateModal/UseTemplateModal.tsx b/frontend/src/features/admin-form/template/UseTemplateModal/UseTemplateModal.tsx
@@ -16,6 +16,10 @@ export type UseTemplateModalProps = Pick<
   'onClose' | 'isOpen'
 > & { formId: string }
 
+/**
+ * Note: The word "Use" in "UseTemplateModal" is not referring to React's "use" convention for hooks.
+ * "UseTemplate" is a FormSG functionality referring to the FormSG feature of utilising another form as a starting template.
+ */
 export const UseTemplateModal = ({
   formId,
   isOpen,

diff --git a/frontend/src/features/admin-form/template/UseTemplateModal/UseTemplateWizardProvider.tsx b/frontend/src/features/admin-form/template/UseTemplateModal/UseTemplateWizardProvider.tsx
@@ -116,6 +116,10 @@ interface UseTemplateWizardProviderProps {
   children: React.ReactNode
 }
 
+/**
+ * Note: The word "Use" in "UseTemplateWizardProvider" is not referring to React's "use" convention for hooks.
+ * "UseTemplate" is a FormSG functionality referring to the FormSG feature of utilising another form as a starting template.
+ */
 export const UseTemplateWizardProvider = ({
   formId,
   children,

diff --git a/frontend/src/features/admin-form/template/mutation.ts b/frontend/src/features/admin-form/template/mutation.ts
@@ -53,6 +53,10 @@ const useCommonHooks = () => {
   }
 }
 
+/**
+ * Note: The word "Use" in "useUseTemplateWizardProvider" is not referring to React's "use" convention for hooks.
+ * "UseTemplate" is a FormSG functionality referring to the FormSG feature of utilising another form as a starting template.
+ */
 export const useUseTemplateMutations = () => {
   const { handleSuccess, handleError } = useCommonHooks()