Documentation fixes

Author: henricasanova

docs/source/api_workflow.rst

@@ -1,5 +1,5 @@
-workflow.file
-=============
+wrench.workflow
+===============
 
 .. automodule:: wrench.workflow
    :members:

wrench/simulation.py

@@ -221,6 +221,7 @@ def add_file(self, name: str, size: int) -> File:
     def get_all_files(self) -> dict[str, File]:
         """
         Get the list of all files
+
         :return: A dictionary of File objects where ta names are keys
         :rtype: dict[str, File]
         """
@@ -307,21 +308,22 @@ def create_cloud_compute_service(self, hostname: str,
                                      property_list: dict[str, str],
                                      message_payload_list: dict[str, float]) -> CloudComputeService:
         """
+        Create a cloud compute service
 
-                :param hostname: name of the (simulated) host on which the compute service should run
-                :type hostname: str
-                :param execution_host: compute resources as a list of hostnames
-                :param scratch_space: the compute service’s scratch space’s mount point (”” means none)
-                :type scratch_space: str
-                :param property_list: a property list ({} means “use all defaults”)
-                :type property_list: dict
-                :param message_payload_list: a message payload list ({} means “use all defaults”)
-                :type message_payload_list: dict
-                :return: the service name
-                :rtype: CloudComputeService
+        :param hostname: name of the (simulated) host on which the compute service should run
+        :type hostname: str
+        :param execution_host: compute resources as a list of hostnames
+        :param scratch_space: the compute service’s scratch space’s mount point (”” means none)
+        :type scratch_space: str
+        :param property_list: a property list ({} means “use all defaults”)
+        :type property_list: dict
+        :param message_payload_list: a message payload list ({} means “use all defaults”)
+        :type message_payload_list: dict
+        :return: the service name
+        :rtype: CloudComputeService
 
-                :raises WRENCHException: if there is any error in the response
-                """
+        :raises WRENCHException: if there is any error in the response
+        """
         data = {"head_host": hostname, "resources": execution_host, "scratch_space": scratch_space,
                 "property_list": json.dumps(property_list),
                 "message_payload_list": json.dumps(message_payload_list)}

wrench/storage_service.py

@@ -20,6 +20,7 @@ class StorageService(SimulationItem):
     def __init__(self, simulation, name: str) -> None:
         """
         Constructor
+        
         :param simulation: simulation object
         :type simulation
         :param name: Storage service name
@@ -30,6 +31,7 @@ def __init__(self, simulation, name: str) -> None:
     def create_file_copy(self, file: File) -> None:
         """
         Creates a copy of a file (ex nihilo) at this storage service
+
         :param file: the file
         :return:
         """
@@ -38,6 +40,7 @@ def create_file_copy(self, file: File) -> None:
     def lookup_file(self, file: File) -> bool:
         """
         Checks whether a copy of a file is stored on the storage service
+
         :param file: the file
         :return: true or false
         :rtype: bool

wrench/workflow.py

@@ -52,6 +52,7 @@ def add_task(self, name: str, flops: float, min_num_cores: int, max_num_cores: i
     def get_tasks(self) -> dict[str, Task]:
         """
         Get the list of all tasks in the workflow
+
         :return: A dictionary of Task objects where task names are keys
         :rtype: dict[str, Task]
         """
@@ -60,6 +61,7 @@ def get_tasks(self) -> dict[str, Task]:
     def get_input_files(self) -> List[str]:
         """
         Get the list of all input files of the workflow
+
         :return: A dictionary of Task objects where task names are keys
         :rtype: dict[str, Task]
         """