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.
The building parameter comes from the calculate_emission() method
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
"""
surface_envelope_emission = []
@ -177,9 +177,8 @@ class LCACarbonWorkflow:
method is hidden to the user.
The method utilizes the EnvelopeEmission and EndOfLifeEmission classes of
(currently named) life_cycle_assessment series of class.
:param boundary: <class
'hub.city_model_structure.
building_demand.thermal_boundary.ThermalBoundary'>
:param boundary:
hub.city_model_structure.building_demand.thermal_boundary.ThermalBoundary
:return: tuple
"""
layer_emission = []
@ -222,9 +221,9 @@ class LCACarbonWorkflow:
the End of Life emission evaluation.
The method utilizes the OpeningEmission and EndOfLifeEmission classes of
(currently named) life_cycle_assessment series of class.
:param building: <class 'hub.city_model_structure.building.Building'>
:param surface: <class
'hub.city_model_structure.building_demand.surface.Surface'>
:param building: hub.city_model_structure.building.Building
:param surface:
hub.city_model_structure.building_demand.surface.Surface
:param boundary:
hub.city_model_structure.building_demand.thermal_boundary.ThermalBoundary
:param opaque_surface_code: str