Skip to content

Commit 9b3ea19

Browse files
authored
Merge pull request #5875 from lisajulia/feature/fix/documentation
Change return type of _init_ of the BlackOilSimulator class
2 parents bff5c9c + 053fe26 commit 9b3ea19

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

python/docstrings_simulators.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
},
77
"PyBlackOilSimulator_filename_constructor": {
88
"signature": "opm.simulators.BlackOilSimulator.__init__(deck_filename: str) -> BlackOilSimulator",
9-
"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"
9+
"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"
1010
},
1111
"PyBlackOilSimulator_objects_constructor": {
1212
"signature": "opm.simulators.BlackOilSimulator.__init__(deck: Deck, state: EclipseState, schedule: Schedule, summary_config: SummaryConfig) -> None",

0 commit comments

Comments
 (0)