From 1f86352ce8d9731b0122219b5ebb312fa5fcef26 Mon Sep 17 00:00:00 2001
From: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>
Date: Wed, 28 Feb 2024 09:49:27 +1100
Subject: [PATCH] Add deprecation and explanation notice to composable

Co-authored-by: Zack Krida <6351754+zackkrida@users.noreply.github.com>
---
 frontend/src/composables/use-analytics.ts | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/frontend/src/composables/use-analytics.ts b/frontend/src/composables/use-analytics.ts
index 96a7f30e9ad..8c1a1663459 100644
--- a/frontend/src/composables/use-analytics.ts
+++ b/frontend/src/composables/use-analytics.ts
@@ -1,5 +1,11 @@
 import { useContext } from "@nuxtjs/composition-api"
 
+/**
+ * This wrapper around the plugin, retained to reduce code churn.
+ * 
+ * @deprecated For new code, use `$sendCustomEvent` from Nuxt context
+ * @see {@link ~/plugins/analytics.ts} for plugin implementation
+ */
 export const useAnalytics = () => {
   const { $sendCustomEvent } = useContext()