Merge remote-tracking branch 'origin/docs_fix' into simulator_clean

# Conflicts:
#	spinnaker_graph_front_end/__init__.py

Author: Christian-B

spinnaker_graph_front_end/__init__.py

@@ -273,22 +273,22 @@ def add_socket_address(database_ack_port_num: Optional[int],
 
 def get_number_of_available_cores_on_machine() -> int:
     """
-    Get the number of cores on this machine that are available to the
+    :returns: The number of cores on this machine that are available to the
     simulation.
     """
     return __get_simulator().get_number_of_available_cores_on_machine
 
 
 def has_ran() -> bool:
     """
-    Get whether the simulation has already run.
+    :returns: True if and only if the simulation has already run.
     """
     return FecDataView.is_ran_ever()
 
 
 def routing_infos() -> RoutingInfo:
     """
-    Get information about how messages are routed on the machine.
+    :returns: The information about how messages are routed on the machine.
     """
     return FecDataView.get_routing_infos()
 
@@ -319,21 +319,21 @@ def placements() -> Never:
 
 def tags() -> Tags:
     """
-    Get the IPTAGs allocated on the machine.
+    :returns: The IPTAGs allocated on the machine.
     """
     return FecDataView.get_tags()
 
 
 def buffer_manager() -> BufferManager:
     """
-    Get the buffer manager being used for loading/extracting buffers.
+    :returns: The buffer manager being used for loading/extracting buffers.
     """
     return FecDataView.get_buffer_manager()
 
 
 def machine() -> Machine:
     """
-    Get the model of the attached/allocated machine.
+    :returns: The model of the attached/allocated machine.
     """
     logger.warning(
         "If you are getting the machine object to locate how many cores you "
@@ -346,7 +346,7 @@ def machine() -> Machine:
 
 def is_allocated_machine() -> bool:
     """
-    Get whether a machine is allocated.
+    :return: True if and only if a machine is allocated.
     """
     return FecDataView.has_machine()
 

spinnaker_graph_front_end/utilities/simulator_vertex.py

@@ -135,6 +135,8 @@ def generate_recording_region(
         :param spec: The data specification being built
         :param region_id:
             Which region is the recording region.
+        :param channel_sizes: List of int being the number of regions
+            and then for each region its size then two zeros
         """
         spec.reserve_memory_region(
             region=region_id,

unittests/test_doc_checker.py

@@ -31,12 +31,26 @@ def test_doc_checks(self) -> None:
         abs_class_file = os.path.abspath(class_file)
         unittest_dir = os.path.dirname(abs_class_file)
         repo_dir = os.path.dirname(unittest_dir)
+
+        # Don't force examples to have docs in inits
         checker = DocsChecker(
-            check_init=False,  # 13 errors in 12 files
-            check_short=False,  # in dependencies
-            check_params=False,  # 4 errors in 2 files
-            check_returns=False,  # 8 errors in 1 files
-            check_properties=False  # in dependencies
+            check_init=False,
+            check_short=True,
+            check_params=True,
+            check_returns=True,
+            check_properties=True
             )
         checker.check_dir(repo_dir)
         checker.check_no_errors()
+
+        # strict tests for main code
+        code_dir = os.path.join(repo_dir, "spinnaker_graph_front_end")
+        checker2 = DocsChecker(
+            check_init=True,
+            check_short=True,
+            check_params=True,
+            check_returns=True,
+            check_properties=True
+            )
+        checker2.check_dir(code_dir)
+        checker2.check_no_errors()