Skip to content

Commit

Permalink
Update file from docstrings_common.json
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jun 25, 2024
1 parent 67dfe61 commit c330188
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions python/docstrings_common.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,27 +76,27 @@
},
"Schedule_shut_well_well_name_step": {
"signature": "opm.io.schedule.Schedule.shut_well(well_name: str, step: int) -> None",
"doc": "Shut down a well at a given report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str\n:param step: The report step at which to shut down the well.\n:type step: int"
"doc": "Shuts down a well at a given report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str\n:param step: The report step at which to shut down the well.\n:type step: int"
},
"Schedule_shut_well_well_name": {
"signature": "opm.io.schedule.Schedule.shut_well(well_name: str) -> None",
"doc": "Shut down a well at the current report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str"
"doc": "Shuts down a well at the current report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str"
},
"Schedule_open_well_well_name_step": {
"signature": "opm.io.schedule.Schedule.open_well(well_name: str, step: int) -> None",
"doc": "Open a well at a given report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str\n:param step: The report step at which to open the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation."
"doc": "Opens a well at a given report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str\n:param step: The report step at which to open the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation."
},
"Schedule_open_well_well_name": {
"signature": "opm.io.schedule.Schedule.open_well(well_name: str) -> None",
"doc": "Open a well at the current report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str"
"doc": "Opens a well at the current report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str"
},
"Schedule_stop_well_well_name_step":{
"signature": "opm.io.schedule.Schedule.stop_well(well_name: str, step: int) -> None",
"doc": "Stop a well at a given report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str\n:param step: The report step at which to stop the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation."
"doc": "Stops a well at a given report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str\n:param step: The report step at which to stop the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation."
},
"Schedule_stop_well_well_name": {
"signature": "opm.io.schedule.Schedule.stop_well(well_name: str) -> None",
"doc": "Stop a well at the current report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str"
"doc": "Stops a well at the current report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str"
},
"Schedule_get_injection_properties": {
"signature": "opm.io.schedule.Schedule.get_injection_properties(well_name: str, report_step: int) -> dict",
Expand Down

0 comments on commit c330188

Please sign in to comment.