From 38c468b29bbed1fe53fbb0ed32762a3ae2d9149c Mon Sep 17 00:00:00 2001
From: Alireza Adli <alireza.adli@mail.concordia.ca>
Date: Sun, 13 Oct 2024 12:40:24 -0400
Subject: [PATCH] Finalize comments

---
 .../access_nrcan_catalogue.py                 | 20 +++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/hub/city_model_structure/life_cycle_assessment/access_nrcan_catalogue.py b/hub/city_model_structure/life_cycle_assessment/access_nrcan_catalogue.py
index d2021bb4..24b3148c 100644
--- a/hub/city_model_structure/life_cycle_assessment/access_nrcan_catalogue.py
+++ b/hub/city_model_structure/life_cycle_assessment/access_nrcan_catalogue.py
@@ -143,7 +143,8 @@ class AccessNrcanCatalog:
 
   def search_material(self, material_name):
     """
-      Brings up the material's embodied carbon based on material's name
+      Search materials and bring up the specific material data
+      based on the material's name
       :param material_name: <class 'str'>
       :return: <class 'dict'>
     """
@@ -152,17 +153,24 @@ class AccessNrcanCatalog:
   def search_transparent_surfaces(
           self, surface_type, opaque_surface_code):
     """
-
-    :param surface_type:
-    :param opaque_surface_code:
-    :return:
+      Search transparent surfaces and bring up the specific surface data
+      based on its type and opaque surface code
+      :param surface_type: <class 'str'>
+      :param opaque_surface_code: <class 'str'>
+      :return: <class 'dict'>
     """
     return self.transparent_surfaces[
       f'{surface_type}_{opaque_surface_code}']
 
   def find_opaque_surface(
           self, function, period_of_construction, climate_zone):
-    """Returns the opaque_surface_name corresponding to the given arguments."""
+    """
+    Returns the opaque_surface_name based on the below parameters.
+    :param function: <class 'str'>
+    :param period_of_construction: <class 'str'>
+    :param climate_zone: <class 'str'>
+    :return: <class 'str'>
+    """
     for archetype in self.archetypes['archetypes']:
       if archetype['function'] != function:
         continue