From 1946d14b81984e7a6b1c999b5e25a9d6ae26b817 Mon Sep 17 00:00:00 2001 From: Lisa Julia Nebel Date: Wed, 24 Jul 2024 15:35:16 +0200 Subject: [PATCH 1/2] Fix typo - and test the automatic deployment to opm-python-documentation with this --- python/docstrings_common.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/python/docstrings_common.json b/python/docstrings_common.json index c13a302296f..d4a00526414 100644 --- 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", From 4e4c361d678d3074821fadc692f472cedcef18cd Mon Sep 17 00:00:00 2001 From: Lisa Julia Nebel Date: Thu, 25 Jul 2024 19:22:47 +0200 Subject: [PATCH 2/2] Only notify opm-python-documentation when the file docstrings_common.json gets changed on master, not for a PR --- .../{dispatch_opm_simulators.yml => dispatch_opm_common.yml} | 4 ---- 1 file changed, 4 deletions(-) rename .github/workflows/{dispatch_opm_simulators.yml => dispatch_opm_common.yml} (89%) diff --git a/.github/workflows/dispatch_opm_simulators.yml b/.github/workflows/dispatch_opm_common.yml similarity index 89% rename from .github/workflows/dispatch_opm_simulators.yml rename to .github/workflows/dispatch_opm_common.yml index bc53a962893..bfc2f8689c0 100644 --- a/.github/workflows/dispatch_opm_simulators.yml +++ b/.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: