update docs

UoaWDCC · Oct 18, 2024 · b47cce3 · b47cce3
1 parent 9d4fb61
commit b47cce3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/client/src/components/composite/EventsView/EventsView.tsx b/client/src/components/composite/EventsView/EventsView.tsx
@@ -26,7 +26,7 @@ interface IEventsPage {
  *
  * - **Do not make any network requests in this component, the data should
  * be fetched seperately and passed in as {@link rawEvents}**
- * - String operations are preferred to be done in {@link EventMessages}
+ * - String operations are ideally done in {@link EventMessages}
  * - Complex date comparisons should also be abstracted away into {@link EventDateComparisons}
  */
 const EventsPage = ({ rawEvents }: IEventsPage) => {

diff --git a/client/src/components/generic/Event/EventPreview/EventPreview.tsx b/client/src/components/generic/Event/EventPreview/EventPreview.tsx
@@ -2,6 +2,9 @@
 import Image from "next/image"
 import Arrow from "@/assets/icons/rightarrow.svg"
 
+/**
+ * The interface (props) associated with {@link EventsCardPreview}
+ */
 export interface IEventsCardPreview {
   /**
    * The image url of image to display