Merge pull request #4147 from lisajulia/feature/documentation-dispatch

Fix typo - and test the automatic deployment to opm-python-documentat…
OPM · Jul 29, 2024 · d075bc8 · d075bc8
2 parents 974bd79 + 4e4c361
commit d075bc8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 6 deletions.
diff --git a/...hub/workflows/dispatch_opm_simulators.yml → .github/workflows/dispatch_opm_common.yml b/...hub/workflows/dispatch_opm_simulators.yml → .github/workflows/dispatch_opm_common.yml
@@ -5,10 +5,6 @@ on:
  branches: master
  paths:
  - 'python/docstrings_common.json'
- pull_request:
- branches: master
- paths:
- - 'python/docstrings_common.json'
 
 jobs:
  dispatch:

diff --git a/python/docstrings_common.json b/python/docstrings_common.json
@@ -112,7 +112,7 @@
  },
  "Schedule_get_well": {
  "signature": "opm.io.schedule.Schedule.get_well(well_name: str, report_step: int) -> Well",
- "doc": "Retrieve a well at a given report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step.\n:type report_step: int\n\n:return: Well object at the given report step. \n:type return: well"
+ "doc": "Retrieves a well at a given report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step.\n:type report_step: int\n\n:return: Well object at the given report step. \n:type return: well"
  },
  "Schedule_get_wells": {
  "signature": "opm.io.schedule.Schedule.get_wells(well_name_pattern: str) -> list",
@@ -155,7 +155,7 @@
  },
  "Well_pos": {
  "signature": "Well.pos() -> tuple",
- "doc": "Retrieve the position of the well.\n\n:return: A tuple containing the (i, j) coordinates and the reference depth of the well. \n:type return: tuple"
+ "doc": "Retrieves the position of the well.\n\n:return: A tuple containing the (i, j) coordinates and the reference depth of the well. \n:type return: tuple"
  },
  "Well_isdefined": {
  "signature": "Well.isdefined(report_step: int) -> bool",