improve docs

UoaWDCC · Aug 28, 2024 · edc2dc4 · edc2dc4
1 parent fa07039
commit edc2dc4
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/client/src/components/composite/LodgeInfo/LodgeInfo.tsx b/client/src/components/composite/LodgeInfo/LodgeInfo.tsx
@@ -18,6 +18,12 @@ export interface ILodgeInfo {
   handleBookLodgeClick?: () => void
 }
 
+/**
+ * Component displaying information about the lodge before the user makes a booking
+ *
+ * Use case - if someone new to the club wants to know what the lodge is, or are unsure about
+ * how to prepare/find more information
+ */
 const LodgeInfo = ({
   children,
   imageSrcs,