Polishing docs

1kastner · Aug 29, 2022 · aef3489 · aef3489
1 parent bf063cb
commit aef3489
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/conflowgen/analyses/abstract_analysis.py b/conflowgen/analyses/abstract_analysis.py
@@ -48,7 +48,8 @@ def __init__(
         """
 
         Args:
-            transportation_buffer: The buffer, e.g. 0.2 means that 20% more containers (in TEU) can be put on a vessel
+            transportation_buffer:
+                The buffer, e.g. 0.2 means that 20% more containers (in TEU) can be put on a vessel
                 compared to the amount of containers it had on its inbound journey - as long as the total vehicle
                 capacity would not be exceeded.
         """

diff --git a/conflowgen/analyses/modal_split_analysis.py b/conflowgen/analyses/modal_split_analysis.py
@@ -27,6 +27,7 @@ class ModalSplitAnalysis(AbstractAnalysis):
     }
 
     def __init__(self):
+        """"""  # overwrite explanation of transportation_buffer
         super().__init__()
         self.container_flow_by_vehicle_type_analysis = ContainerFlowByVehicleTypeAnalysis()
 

diff --git a/conflowgen/tools/continuous_distribution.py b/conflowgen/tools/continuous_distribution.py
@@ -32,7 +32,7 @@ def __init__(
             average: The expected mean of the distribution.
             minimum: The minimum of the distribution. Smaller values are automatically set to zero.
             maximum: The maximum of the distribution. Larger values are automatically set to zero.
-            unit: The unit for the average, minimum, and maximum. It is used for the __repr__ implementation.
+            unit: The unit for the average, minimum, and maximum. It is used for the ``__repr__`` implementation.
         """
         assert minimum < maximum, f"The assertion {minimum} < {maximum} failed."
         if average is not None: