Correct the methods descriptions

This commit is contained in:
Alireza Adli 2024-12-01 12:15:02 -05:00
parent 4cfec33147
commit c809ffda1b

View File

@ -114,7 +114,7 @@ class LCACarbonWorkflow:
method. The attributes and their types are explained in the constructor. method. The attributes and their types are explained in the constructor.
The building parameter comes from the calculate_emission() method The building parameter comes from the calculate_emission() method
which iterates through the city object buildings. which iterates through the city object buildings.
:param building: <class 'hub.city_model_structure.building.Building'> :param building: hub.city_model_structure.building.Building
:return: tuple :return: tuple
""" """
surface_envelope_emission = [] surface_envelope_emission = []
@ -177,9 +177,8 @@ class LCACarbonWorkflow:
method is hidden to the user. method is hidden to the user.
The method utilizes the EnvelopeEmission and EndOfLifeEmission classes of The method utilizes the EnvelopeEmission and EndOfLifeEmission classes of
(currently named) life_cycle_assessment series of class. (currently named) life_cycle_assessment series of class.
:param boundary: <class :param boundary:
'hub.city_model_structure. hub.city_model_structure.building_demand.thermal_boundary.ThermalBoundary
building_demand.thermal_boundary.ThermalBoundary'>
:return: tuple :return: tuple
""" """
layer_emission = [] layer_emission = []
@ -222,9 +221,9 @@ class LCACarbonWorkflow:
the End of Life emission evaluation. the End of Life emission evaluation.
The method utilizes the OpeningEmission and EndOfLifeEmission classes of The method utilizes the OpeningEmission and EndOfLifeEmission classes of
(currently named) life_cycle_assessment series of class. (currently named) life_cycle_assessment series of class.
:param building: <class 'hub.city_model_structure.building.Building'> :param building: hub.city_model_structure.building.Building
:param surface: <class :param surface:
'hub.city_model_structure.building_demand.surface.Surface'> hub.city_model_structure.building_demand.surface.Surface
:param boundary: :param boundary:
hub.city_model_structure.building_demand.thermal_boundary.ThermalBoundary hub.city_model_structure.building_demand.thermal_boundary.ThermalBoundary
:param opaque_surface_code: str :param opaque_surface_code: str