1228 Update coding guidelines and correct readme format (#1254)

Author: kilianvolmer

docs/source/development.rst

@@ -74,6 +74,7 @@ Includes:
 Code Documentation:
 
   - Use doxygen docstrings. In particular
+  
     - Write an explicit `@brief` for method documentations. Continue the detailed description in the next line.
     - Always start a line with a capital letter and end with a dot.
     - The plural of classes, objects etc. should be denoted with a `%` sign between class name and plural s, e.g., `Household%s`. This is in order to visualize it correctly and provide a link on the doxygen page.

docs/source/models/sde_sirs.rst

@@ -16,19 +16,19 @@ Below is an overview of the model architecture and its compartments.
 .. image:: https://github.com/SciCompMod/memilio/assets/69154294/bdde5ca3-cd7d-4695-8704-03a712c92ff7
    :alt: SIR_model
 
-+-------------------------------+-----------------------------------------------+----------------------------------------------------------------------------------------------+
-| Mathematical variable         | C++ variable name                             | Description                                                                                  |
-+===============================+===============================================+==============================================================================================+
-| :math:`\phi`                 | ``ContactPatterns``                           | Daily contact rate / Number of daily contacts.                                               |
-+-------------------------------+-----------------------------------------------+----------------------------------------------------------------------------------------------+
-| :math:`\rho`                 | ``TransmissionProbabilityOnContact``        | Transmission risk for people located in the Susceptible compartment.                         |
-+-------------------------------+-----------------------------------------------+----------------------------------------------------------------------------------------------+
-| :math:`N`                    | ``populations.get_total()``                   | Total population.                                                                            |
-+-------------------------------+-----------------------------------------------+----------------------------------------------------------------------------------------------+
-| :math:`T_{I}`                | ``TimeInfected``                              | Time in days an individual stays in the Infected compartment.                               |
-+-------------------------------+-----------------------------------------------+----------------------------------------------------------------------------------------------+
-| :math:`T_{R}`                | ``TimeImmune``                                | Time in days an individual stays in the Recovered compartment before becoming Susceptible again. |
-+-------------------------------+-----------------------------------------------+----------------------------------------------------------------------------------------------+
++-------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------+
+| Mathematical variable         | C++ variable name                             | Description                                                                                            |
++===============================+===============================================+========================================================================================================+
+| :math:`\phi`                  | ``ContactPatterns``                           | Daily contact rate / Number of daily contacts.                                                         |
++-------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------+
+| :math:`\rho`                  | ``TransmissionProbabilityOnContact``          | Transmission risk for people located in the Susceptible compartment.                                   |
++-------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------+
+| :math:`N`                     | ``populations.get_total()``                   | Total population.                                                                                      |
++-------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------+
+| :math:`T_{I}`                 | ``TimeInfected``                              | Time in days an individual stays in the Infected compartment.                                          |
++-------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------+
+| :math:`T_{R}`                 | ``TimeImmune``                                | Time in days an individual stays in the Recovered compartment before becoming Susceptible again.       |
++-------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------+
 
 An example can be found in the
 `examples/ode_sir.cpp <https://github.com/SciCompMod/memilio/blob/main/cpp/examples/ode_sir.cpp>`_.