Skip to content
Snippets Groups Projects
Commit 722749dd authored by Oscar Gustafsson's avatar Oscar Gustafsson :bicyclist:
Browse files

Add documentation for save_load_structure

parent 047cf9d8
No related branches found
No related tags found
1 merge request!224Add documentation for save_load_structure
Pipeline #90261 passed
"""
B-ASIC Save/Load Structure Module.
Contains functions for saving/loading SFGs to/from strings that can be stored
as files.
Contains functions for saving/loading SFGs and Schedules to/from strings that can be
stored as files.
"""
from datetime import datetime
......@@ -158,7 +158,7 @@ def python_to_sfg(path: str) -> Tuple[SFG, Dict[str, Tuple[int, int]]]:
)
def schedule_to_python(schedule: Schedule):
def schedule_to_python(schedule: Schedule) -> str:
"""
Given a schedule structure try to serialize it for saving to a file.
......
......@@ -11,6 +11,7 @@ API
port.rst
process.rst
resources.rst
save_load_structure.rst
schedule.rst
sfg_generators.rst
signal.rst
......
******************************
``b_asic.save_load_structure``
******************************
.. automodule:: b_asic.save_load_structure
:members:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment