From edc2dc42c03be2f43086cfe71a32016a14aa9b19 Mon Sep 17 00:00:00 2001 From: bcho892 Date: Thu, 29 Aug 2024 10:30:57 +1200 Subject: [PATCH] improve docs --- client/src/components/composite/LodgeInfo/LodgeInfo.tsx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/client/src/components/composite/LodgeInfo/LodgeInfo.tsx b/client/src/components/composite/LodgeInfo/LodgeInfo.tsx index f98ec280b..783ac19d6 100644 --- 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,