Merge pull request #5880 from lisajulia/feature/fix/documentation

Add missing return type to check_simulation_finished function of BlackOilSimulator.
OPM · Jan 14, 2025 · 70987f4 · 70987f4
2 parents 070af4f + 6fecef3
commit 70987f4
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/python/docstrings_simulators.json b/python/docstrings_simulators.json
@@ -18,7 +18,7 @@
     },
     "checkSimulationFinished": {
         "signature": "opm.simulators.BlackOilSimulator.check_simulation_finished() -> bool",
-        "doc": "Checks if the simulation has finished.\n\n:return: True if the simulation is finished, False otherwise."
+        "doc": "Checks if the simulation has finished.\n\n:return: True if the simulation is finished, False otherwise.\n:type return: bool"
     },
     "currentStep": {
         "signature": "opm.simulators.BlackOilSimulator.current_step() -> int",