OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Add missing return type to check_simulation_finished function of BlackOilSimulator.
This commit is contained in:
Lisa Julia Nebel 2025-01-14 15:15:04 +01:00 committed by GitHub
commit 70987f4e48
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/docstrings_simulators.json
View File

@ -18,7 +18,7 @@
}, },
"checkSimulationFinished": { "checkSimulationFinished": {
"signature": "opm.simulators.BlackOilSimulator.check_simulation_finished() -> bool", "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": { "currentStep": {
"signature": "opm.simulators.BlackOilSimulator.current_step() -> int", "signature": "opm.simulators.BlackOilSimulator.current_step() -> int",