Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo - and test the automatic deployment to opm-python-documentat… #4147

Merged
merged 2 commits into from
Jul 29, 2024
Merged

Fix typo - and test the automatic deployment to opm-python-documentat… #4147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1946d14
Fix typo - and test the automatic deployment to opm-python-documentat…
lisajulia Jul 24, 2024
4e4c361
Only notify opm-python-documentation when the file docstrings_common.…
lisajulia Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions ...hub/workflows/dispatch_opm_simulators.yml → .github/workflows/dispatch_opm_common.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ on:
branches: master
paths:
- 'python/docstrings_common.json'
pull_request:
branches: master
paths:
- 'python/docstrings_common.json'

jobs:
dispatch:
Expand Down
4 changes: 2 additions & 2 deletions python/docstrings_common.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down