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.

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

Rename job.py to fm_step.py and Job to ForwardModelStep #9022

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

berland
Copy link
Contributor

@berland berland commented Oct 23, 2024

Issue
Resolves eye itch

Approach
nvim

  • PR title captures the intent of the changes, and is fitting for release notes.
  • Added appropriate release note label
  • Commit history is consistent and clean, in line with the contribution guidelines.
  • Make sure unit tests pass locally after every commit (git rebase -i main --exec 'pytest tests/ert/unit_tests -n logical -m "not integration_test"')

When applicable

  • When there are user facing changes: Updated documentation
  • New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
  • Large PR: Prepare changes in small commits for more convenient review
  • Bug fix: Add regression test for the bug
  • Bug fix: Create Backport PR to latest release

@berland berland marked this pull request as draft October 23, 2024 08:15
@berland berland marked this pull request as ready for review October 23, 2024 08:35
@berland berland self-assigned this Oct 23, 2024
@@ -76,7 +76,7 @@ def killed_by_oom(pids: Sequence[int]) -> bool:
return False


class Job:
class FMstep:
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a nitpick, but I think the S should be big too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It probably should. Potentially go all the way and write it as ForwardModelStep? That object name is actually not in use anywhere else in the codebase (although we do use it as a prefix for some other object names)

Copy link
Contributor

Choose a reason for hiding this comment

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

ForwardModelStep sounds better to me

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

Copy link
Contributor

@eivindjahren eivindjahren left a comment

Choose a reason for hiding this comment

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

👍

@berland berland changed the title Rename job.py to fm_step.py Rename job.py to fm_step.py and Job to ForwardModelStep Oct 23, 2024
@berland berland added the release-notes:maintenance Automatically categorise as maintenance change in release notes label Oct 23, 2024
Copy link
Contributor

@yngve-sk yngve-sk left a comment

Choose a reason for hiding this comment

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

LGTM. Final nitpick; would consider renaming the file fm_step.py to forward_model_step.py for consistency, but this is a good change regardless

Plus follow-up in test code and filenames
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.96%. Comparing base (a867d62) to head (d85caf2).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9022      +/-   ##
==========================================
+ Coverage   90.87%   90.96%   +0.09%     
==========================================
  Files         352      352              
  Lines       21712    21712              
==========================================
+ Hits        19730    19751      +21     
+ Misses       1982     1961      -21     
Flag Coverage Δ
cli-tests 39.11% <ø> (+0.14%) ⬆️
gui-tests 72.66% <ø> (ø)
performance-tests 49.56% <ø> (-0.02%) ⬇️
unit-tests 79.67% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@berland berland merged commit a630109 into equinor:main Oct 24, 2024
56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes:maintenance Automatically categorise as maintenance change in release notes
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants