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

Jump to bottom

Add documentation #4018

Merged
merged 9 commits into from
Jun 26, 2024
Merged

Add documentation #4018

merged 9 commits into from
Jun 26, 2024

Conversation

lisajulia
Copy link
Contributor

@lisajulia lisajulia commented Apr 17, 2024 •
edited
Loading

This PR builds on #4029 which should be merged first.
It adds documentation to some methods that are 'not-so-clear'.

@lisajulia lisajulia added this to the Release 2024.04 milestone Apr 17, 2024
@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch 3 times, most recently from f6d999a to bab2495 Compare April 18, 2024 13:00
@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from bab2495 to b7a0559 Compare April 26, 2024 11:46
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from b7a0559 to ebc897e Compare April 26, 2024 12:33
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from ebc897e to 450b7af Compare April 29, 2024 06:59
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from 450b7af to 5360101 Compare April 29, 2024 07:36
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from 5360101 to 2f480a1 Compare April 29, 2024 14:32
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch 7 times, most recently from 60ea2ea to f93509e Compare April 30, 2024 15:01
@blattms
Copy link
Member

blattms commented Apr 30, 2024 •
edited
Loading

Looks good.
Just one question. With these changes, do we need to update the *.pyi file?

@lisajulia lisajulia removed this from the Release 2024.04 milestone May 2, 2024
@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch 3 times, most recently from 534ac88 to 78ca5d8 Compare May 7, 2024 08:51
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from 78ca5d8 to 538eaa4 Compare May 7, 2024 10:41
@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from 538eaa4 to 071d105 Compare May 7, 2024 10:58
@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from faa6e8d to d789f8e Compare June 7, 2024 07:29
@lisajulia lisajulia mentioned this pull request Jun 17, 2024
Open
@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch 7 times, most recently from 7539bdd to be0bfbb Compare June 25, 2024 14:53
@lisajulia
Copy link
Contributor Author

lisajulia commented Jun 25, 2024 •
edited
Loading

To make the whole "automatic deployment of the documentation work" we need to add a token here, such that a change in opm-common/python/docstrings_common.json triggers a workflow in opm-simulators.

For this we need to:

@hakonhagland
Copy link
Contributor

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch 2 times, most recently from f2dea4c to 1a634b6 Compare June 26, 2024 05:19
@lisajulia
Copy link
Contributor Author

@blattms and @hakonhagland: This is finally ready for review :)

@lisajulia
Copy link
Contributor Author

jenkins build this please

@lisajulia lisajulia force-pushed the feature/pyAction-add-documentation branch from 1a634b6 to 73cc234 Compare June 26, 2024 05:43
@lisajulia
Copy link
Contributor Author

jenkins build this please

hakonhagland
hakonhagland approved these changes Jun 26, 2024
View reviewed changes
.github/workflows/dispatch_opm_simulators.yml
curl -X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token ${{ secrets.PERSONAL_ACCESS_TOKEN }}" \
https://api.github.com/repos/lisajulia/opm-simulators/dispatches \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this needs to change to OPM instead of lisajulia when this workflow is activated ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, thanks! I've opened a new PR: #4129

@blattms
Copy link
Member

blattms commented Jun 26, 2024

Approved by @hakonhagland and I trust him. Comment can be addressed once someone actually activates github action. Merging.

@blattms blattms merged commit ae5bef9 into OPM:master Jun 26, 2024
1 check passed
@lisajulia lisajulia deleted the feature/pyAction-add-documentation branch July 1, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bska bska bska left review comments

@hakonhagland hakonhagland hakonhagland approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@lisajulia @blattms @bska @hakonhagland