Skip to content

Commit

Permalink
Merge pull request #5876 from lisajulia/feature/fix/documentation
Browse files Browse the repository at this point in the history
[Python/docs] Change return type of other _init_ of the BlackOilSimulator class
  • Loading branch information
atgeirr authored Jan 14, 2025
2 parents 21c534f + 6958abd commit 4845476
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions python/docstrings_simulators.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
"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": {
"signature": "opm.simulators.BlackOilSimulator.__init__(deck: Deck, state: EclipseState, schedule: Schedule, summary_config: SummaryConfig) -> None",
"doc": "Constructor using Deck, EclipseState, Schedule, and SummaryConfig objects.\n\n:param deck: Deck object.\n:type deck: Deck\n:param state: EclipseState object.\n:type state: EclipseState\n:param schedule: Schedule object.\n:type schedule: Schedule\n:param summary_config: SummaryConfig object.\n:type summary_config: SummaryConfig"
"signature": "opm.simulators.BlackOilSimulator.__init__(deck: Deck, state: EclipseState, schedule: Schedule, summary_config: SummaryConfig) -> BlackOilSimulator",
"doc": "Constructor using Deck, EclipseState, Schedule, and SummaryConfig objects.\n\n:param deck: Deck object.\n:type deck: Deck\n:param state: EclipseState object.\n:type state: EclipseState\n:param schedule: Schedule object.\n:type schedule: Schedule\n:param summary_config: SummaryConfig object.\n:type summary_config: SummaryConfig\n:return: The BlackOilSimulator.\n:type return: BlackOilSimulator"
},
"advance": {
"signature": "opm.simulators.BlackOilSimulator.advance(report_step: int) -> None",
Expand Down

0 comments on commit 4845476

Please sign in to comment.