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

Change return type of _init_ of the BlackOilSimulator class
This commit is contained in:
Atgeirr Flø Rasmussen 2025-01-14 10:54:12 +01:00 committed by GitHub
commit 9b3ea1936f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -6,7 +6,7 @@
}, },
"PyBlackOilSimulator_filename_constructor": { "PyBlackOilSimulator_filename_constructor": {
"signature": "opm.simulators.BlackOilSimulator.__init__(deck_filename: str) -> BlackOilSimulator", "signature": "opm.simulators.BlackOilSimulator.__init__(deck_filename: str) -> BlackOilSimulator",
"doc": "Constructor using a deck file name.\n\n:param deck_filename: The file name of the deck to be used for the simulation.\n:type deck_filename: str" "doc": "Constructor using a deck file name.\n\n:param deck_filename: The file name of the deck to be used for the simulation.\n:type deck_filename: str\n:return: The BlackOilSimulator.\n:type return: BlackOilSimulator"
}, },
"PyBlackOilSimulator_objects_constructor": { "PyBlackOilSimulator_objects_constructor": {
"signature": "opm.simulators.BlackOilSimulator.__init__(deck: Deck, state: EclipseState, schedule: Schedule, summary_config: SummaryConfig) -> None", "signature": "opm.simulators.BlackOilSimulator.__init__(deck: Deck, state: EclipseState, schedule: Schedule, summary_config: SummaryConfig) -> None",