Merge pull request #1658 from steffengraber/fix-issue-1555

Fixed rendering of kernel parameter documentation in PyNEST

pynest/nest/lib/hl_api_simulation.py

@@ -189,16 +189,19 @@ def SetKernelStatus(params):
     params : dict
         Dictionary of parameters to set.
 
+
     Params dictionary
-    --------------------
 
     Some of the keywords in the kernel status dictionary are internally
     calculated, and cannot be defined by the user. These are flagged as
     `read only` in the parameter list. Use GetKernelStatus to access their
     assigned values.
 
+
     Time and resolution
-    ~~~~~~~~~~~~~~~~~~~
+
+    Parameters
+    ----------
 
     resolution : float
         The resolution of the simulation (in ms)
@@ -221,8 +224,11 @@ def SetKernelStatus(params):
     T_min : float, read only
         The smallest representable time value
 
+
     Parallel processing
-    ~~~~~~~~~~~~~~~~~~~
+
+    Parameters
+    ----------
 
     total_num_virtual_procs : int
         The total number of virtual processes
@@ -240,8 +246,11 @@ def SetKernelStatus(params):
         most purposes. Array with one integer per virtual process, all must
         be unique and differ from grng_seed.
 
+
     MPI buffers
-    ~~~~~~~~~~~
+
+    Parameters
+    ----------
 
     adaptive_spike_buffers  : bool
         Whether MPI buffers for communication of spikes resize on the fly
@@ -265,8 +274,11 @@ def SetKernelStatus(params):
     max_buffer_size_target_data : int
         Maximal size of MPI buffers for communication of connections
 
+
     Waveform relaxation method (wfr)
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Parameters
+    ----------
 
     use_wfr : bool
         Whether to use waveform relaxation method
@@ -279,8 +291,11 @@ def SetKernelStatus(params):
     wfr_interpolation_order : int
         Interpolation order of polynomial used in wfr iterations
 
+
     Synapses
-    ~~~~~~~~
+
+    Parameters
+    ----------
 
     max_num_syn_models : int, read only
         Maximal number of synapse models supported
@@ -298,8 +313,11 @@ def SetKernelStatus(params):
         manager will make changes in the structure of the network (creation
         and deletion of plastic synapses)
 
+
     Output
-    ~~~~~~
+
+    Returns
+    -------
 
     data_path : str
         A path, where all data is written to (default is the current
@@ -320,8 +338,11 @@ def SetKernelStatus(params):
         (neuron models with proxies) are counted, not spikes generated by
         devices such as poisson_generator.
 
+
     Miscellaneous
-    ~~~~~~~~~~~~~
+
+    Other Parameters
+    ----------------
 
     dict_miss_is_error : bool
         Whether missed dictionary entries are treated as errors