Skip to content

Commit b6cf0f5

Browse files
committed
Updated docstrings
1 parent cd21dc3 commit b6cf0f5

1 file changed

Lines changed: 0 additions & 20 deletions

File tree

src/main.py

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -299,13 +299,6 @@ def Initialization(TRNData: Dict[str, Dict[str, List[Union[int, float]]]]) -> No
299299
This function initializes global variable 'servers' by connecting to servers
300300
based on the provided server configurations in SERVER_CONFIGS.
301301
302-
Examples
303-
--------
304-
>>> Initialization(TRNData)
305-
306-
The above example initializes servers using the configuration provided in
307-
'TRNData'.
308-
309302
"""
310303

311304
global servers
@@ -389,13 +382,6 @@ def EndOfTimeStep(TRNData: Dict[str, Dict[str, List[Union[int, float]]]]) -> Non
389382
This function iterates over connected servers, writes inputs based on the provided
390383
TRNData, and reads outputs if applicable. It logs relevant information during the process.
391384
392-
Examples
393-
--------
394-
>>> EndOfTimeStep(TRNData)
395-
396-
The above example performs end-of-time-step actions on connected servers using the
397-
values provided in 'TRNData'.
398-
399385
"""
400386

401387
try:
@@ -444,12 +430,6 @@ def LastCallOfSimulation(TRNData: Dict[str, Dict[str, List[Union[int, float]]]])
444430
If an error occurs during the last call of the simulation, an exception is raised.
445431
The error is logged using the logging module.
446432
447-
Examples
448-
--------
449-
>>> trn_data = {'SIMULATION_MODEL': {'outputs': [0, 0, 0]}}
450-
>>> LastCallOfSimulation(trn_data)
451-
>>> # Perform actions at the end of the entire TRNSYS simulation
452-
453433
"""
454434

455435
try:

0 commit comments

Comments
 (0)